aws-parameters-store - npm Package Compare versions

Comparing version 1.0.9 to 1.0.10

package.json

 {
   "name": "aws-parameters-store",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Loads parameters from aws parameter store to a json object",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 # aws-parameters-store
 
-# Installation
-> `npm install --save aws-parameters-store`
+Package for loading parameter-store values by path from AWS SSM into a JSON object
 
-# Summary
-This package builds nested object from your AWS parameter store under specified path
+## Features
+- Gets parameters by path
+- Collects all paged results automatically
+- Built in typescript! (Built-in types)
+- Uses Promises for async use
+- Lightweight
 
+## Installation
+>  `npm install --save aws-parameters-store`
+
+## Getting started
+
+### javascript
+```js
+const  paramStore  =  require( 'aws-parameters-store' );
+
+paramStore.getParams('/hello-world/config1/', { region: 'us-east-1' })
+    .then( (parameters) => {
+
+        // do something here
+    });
+```
+### typescript
+```ts
+import  getParams  from  'aws-parameters-store';
+
+getParams('/hello-world/config1/', { region: 'us-east-1' })
+    .then( (parameters) => {
+
+        // do something here
+    });
+```
+
+## API
+### overview
+API calls return a promise
+By default, JSON parameters are being evaluated
+
+### `getParams( namespace, { options }, parseJsonValues = true )`
+
+
+```ts
+import  getParams  from  'aws-parameters-store';
+
+getParams('/hello-world/config1/', { region: 'us-east-1' })
+    .then( (parameters) => {
+    
+/* parameters = {
+					feature: { 
+						authorization: true,
+						authentication: false
+					}, 
+					deployment: { 
+						  color: "blue"
+					}
+					version: "beta-27ea91f",
+					tags: ["pre-production", "beta", "rc2"]
+				} 
+*/
+	.catch( (error) => console.log(error));
+
+    });
+```
+  
+## Contributing
+You are welcome to contribute and join our family =)
+
+
 # License
 
 See the [LICENSE](https://github.com/Vonage/aws-parameters-store/blob/master/LICENSE.txt) file for license rights and limitations (Apache License, Version 2.0)

No alert changes

Improved metrics

Total package byte prevSize

14713

increased by10.02%

Number of lines in readme file

75

increased by581.82%

No dependency changes