@elevatormedia/paymigo - npm Package Compare versions

Comparing version 0.1.5-alpha.5 to 0.1.5-alpha.6

dist/Client.js

@@ -14,3 +14,3 @@ "use strict";
         this._client = null;
-        let environment = null;
+        let environment;
         if (options.mode === 'sandbox')
@@ -17,0 +17,0 @@ environment = new checkout_server_sdk_1.default.core.SandboxEnvironment(options.clientId, options.secretKey);

package.json

 {
     "name": "@elevatormedia/paymigo",
-    "version": "0.1.5-alpha.5",
+    "version": "0.1.5-alpha.6",
     "description": "TypeScript wrapper and extension of PayPal Node.js SDK and REST APIs",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 # paymigo
 
-TypeScript wrapper and extension of [PayPal Node.js Checkout SDK](https://github.com/paypal/Checkout-NodeJS-SDK#readme).
+TypeScript wrapper and extension of [PayPal's Node.js Checkout SDK](https://github.com/paypal/Checkout-NodeJS-SDK#readme).
+
+## Purpose
+
+PayPal is one of the premiere ecommerce service providers and Node.js has only been rising in popularity. However, PayPal's [Checkout Node SDK](https://github.com/paypal/Checkout-NodeJS-SDK) lacks types and an easy-to-use API client for a better developer experience. This library serves to expose all existing funtionality of `@paypal/checkout-server-sdk` with an easy to use API, TS-first support with static typing for new clients as well as legacy types, and extend existing functionality to encompass more of PayPal's REST API's potential.
+
+As of this writing, it's core implementation is built around the original client then extends functionality by providing more request options and a client that's easier to implement. In the future, we plan to rebuild to core client, but our primary focus will be providing a simple and cohesive developer experience to making using PayPal's platform easier.
+
+## Getting Started
+
+First, install the library with your preferred package manager:
+
+### npm
+
+```bash
+npm install @elevatormedia/paymigo
+```
+
+### yarn
+
+```bash
+yarn add @elevatormedia/paymigo
+```
+
+Configuration requires a valid Client ID and Secret Key recovered from your PayPal developer dashboard. We recommend adding them to your environment variables.
+
+The Paymigo client is then created by pairing those with your environment type:
+
+```ts
+import PaymigoClient from '@elevatormedia/paymigo';
+
+const client = new PaymigoClient({
+    mode: 'sandbox',
+    clientId: '<CLIENT_ID>',
+    secretKey: '<SECRET_KEY>',
+});
+```

New alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

86667

increased by17.43%

Number of package files

95

increased by1.06%

Number of lines in readme file

40

increased by900%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

No dependency changes