release: v2.1.0

updated readme & added .npmignore

.npmignore

@@ -0,0 +1,15 @@
+# folders
+.idea
+.github
+.nyc_output
+coverage
+test
+exclude
+node_modules
+
+# files
+.gitignore
+.npmignore
+.nycrc.json
+.travis.yml
+yarn.lock

README.md

@@ -1,34 +1,43 @@
-# json-keys-sort    
-[![Build Status](https://travis-ci.org/DawnImpulse/json-keys-sort.svg?branch=master)](https://travis-ci.org/DawnImpulse/json-keys-sort) [![Coverage Status](https://coveralls.io/repos/github/DawnImpulse/json-keys-sort/badge.svg?branch=master)](https://coveralls.io/github/DawnImpulse/json-keys-sort?branch=master) ![wait-loop](https://img.shields.io/npm/dt/json-keys-sort.svg)
- > Sorting a json object based on keys either ascending or descending & even recursively    
 
-### Latest Changes	
-- **sort** now throws an error if not provided with an object
-- added support for Typescript
 
-### Example -   
-> Note : focus on **keys** not values  
-  
+# json-keys-sort
+![ts](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555) ![NPM](https://img.shields.io/npm/l/error-key) ![npm](https://img.shields.io/npm/v/json-keys-sort) [![Build Status](https://app.travis-ci.com/DawnImpulse/json-keys-sort.svg?branch=master)](https://app.travis-ci.com/DawnImpulse/json-keys-sort) [![Coverage Status](https://coveralls.io/repos/github/DawnImpulse/json-keys-sort/badge.svg?branch=master)](https://coveralls.io/github/DawnImpulse/json-keys-sort?branch=master) ![wait-loop](https://img.shields.io/npm/dt/json-keys-sort.svg) ![install size](https://packagephobia.com/badge?p=json-keys-sort) [![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/dawnimpulse/json-keys-sort)
+> Sorting a json object based on keys either ascending or descending & even recursively
+
+### Latest Changes	(v2.1.0)
+- **sortAsync** : this is a new function which returns a promise
+
+### Installation
+`npm install json-keys-sort`
+or
+`yarn add json-keys-sort`
+
+### Example -
+> Note : focus on **keys** not values
 ~~~~    
 const json = require('json-keys-sort');    
 var data = {    
-	"zoho": 4,    
-	"drake": 2,    
-	"yogo": {    
-		"jout": "3.2",    
-		"aou": {    
-			"yoyo": "3.1.3",    
-			"aalo": "3.1.1",    
-			"go": "3.1.2"    
-		}    
-	},    
-	"abc": 1    
-}    
-    
-json.sort(data,true)    
+               "zoho": 4,    
+               "drake": 2,    
+               "yogo": {    
+                   "jout": "3.2",    
+                   "aou": {    
+                       "yoyo": "3.1.3",    
+                       "aalo": "3.1.1",    
+                       "go": "3.1.2"    
+                   }    
+               },    
+               "abc": 1    
+           }    
+
+// sync (return sorted data)
+json.sort(data, true)    
+
+// async (return promise of sorted data)
+json.sortAsync(data, true)
 ~~~~    
-   
-Output will be -    
+
+Output will be -
 ~~~~    
 {    
 	"abc": 1,    
@@ -42,19 +51,21 @@ Output will be -
 		"jout": "3.2"    
 	},    
 	"zoho": 4    
-}    
+}  
 ~~~~    
-
-+ function parameters    
-   - data : the json object to sort  
-   - sort :   
-      - true (default) : ascending sort , since it is default you can only call `json.sort(data)`  
-	 - false : descending sort  
-> Note : the function assumes that you always provide a json object  
-  
-+ The function work recursively and sort all the inner json objects too.  
+
++ function parameters  (for both **sort** & **sortAsync**)
+	- **data:** the json object to sort
+	- **sort:**
+		- true (default) : ascending sort , since it is default you can only call `json.sort(data)` or `json.sortAsync(data)`
+		- false : descending sort
+
++ The function work recursively and sort all the inner json objects too.
 
 ### Versions
++ `v2.1.0`
+	+ **sortAsync** : this is a new function which returns a promise
+
 + `v2.0.0`
 	+ New : **100%** code coverage
 	+ Improvement : **sort** now throws an error if not provided with an object
@@ -64,7 +75,7 @@ Output will be -
 
 + `v1.3.0`
 	+ Included support for typescript (added declaration file)
-	
+
 +  `v1.2.0`
 	+ Improvement : json array support
 
@@ -75,31 +86,35 @@ Output will be -
 +  `v1.0.1`
 	+ Bug Fixed : data null checks & default true fix
 
-+  `v1.0.0`
++ `v1.0.0`
 	+ Initial release - containing basic `sort` function only.
 
-> Pull requests are always welcomed (kindly sign commits with GPG keys. **THANKS**)  
-    
-### Contact  
-
-+ Twitter - [@dawnimpulse](https://twitter.com/dawnimpulse)  
-+ Email - [[email protected]](mailto:[email protected])
-
-
-
-### License (ISC)  
-~~~~
-ISC Licence
 
-Copyright 2018-2019 Saksham (DawnImpulse)
+> Pull requests are always welcomed (kindly sign commits with GPG keys. **THANKS**)
 
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
-provided that the above copyright notice and this permission notice appear in all copies.
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
-WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISIN
+### Contact
+Twitter - [@dawnimpulse](https://twitter.com/dawnimpulse)  
+Email - [[email protected]](mailto://[email protected])
+
+### Treeware
+This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/dawnimpulse/json-keys-sort) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
+
+
+### License (ISC)
+~~~~  
+ISC License  
+  
+Copyright 2021, Saksham Khurana (DawnImpulse)  
+  
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,  
+provided that the above copyright notice and this permission notice appear in all copies.  
+  
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL  
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,  
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,  
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE  
+OR PERFORMANCE OF THIS SOFTWARE.
 ~~~~
 
 > Written with [StackEdit](https://stackedit.io/).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-keys-sort",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Sorting a json object based on keys either ascending or descending & even recursively",
   "main": "index.js",
   "types": "index.d.ts",