sample-package-esqueleton - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "sample-package-esqueleton",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A simple esqueleton package meant for starter packages",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -0,1 +1,2 @@
+
 # Sample NPM Package - Esqueleton 
@@ -5,4 +6,15 @@
 
-A simple starter package to create your own npm module with API requests. 
+A simple starter package to create your own npm module with API requests. This module was created with the intention to teach new node developers on how to create a module that uses an Apikey. 
 
+## Quick Use
+
+```
+const { SampleApiRequestHandler } = require('sample-package-esqueleton/src'); 
+const client = new SampleApiRequestHandler();
+
+client
+  .getApiRequest({ id: '1' })
+  .then(data => console.log(data));
+```
+
 ## Getting Started
@@ -9,0 +21,0 @@

No alert changes

Improved metrics

Total package byte prevSize

14213

3.24%

Number of package files

8

14.29%

Lines of code

291

1.39%

Number of lines in readme file

84

16.67%

No dependency changes