readme contributing docs

Author: arshadkazmi42

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+### Thanks, for considering to contribute to this repository! 
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+If you are looking forward to start contributing to beautiful world of open source.
+**Start it right now.**
+
+The basic guidelines for contributing are as follows:  
+- Fork the repo
+- Clone the repo
+- Create a branch using 
+  - `git checkout -b feature-branch`
+- Make the required changes
+- Test the changes by using below command
+  - `yarn` (Installs all the dependencies)
+  - `yarn test`
+- Create a pull request using below commands
+  - `git add --all`
+  - `git commit -m "your commit message"`
+  - `git push origin feature-branch`
+- Go to [Repository](https://github.com/arshadkazmi42/json-nested-replace/)
+- Create Pull Request against `master` branch
+- Add a suitable title and description to the pull request and tag the issue number in Pull Request description, if the pull request is related to some issue logged here: [Issues](https://github.com/arshadkazmi42/json-nested-replace/issues)
+- You're done. Wait for your code to get reviewed and merged
+- Optional: Give us a :star: if you like our work :smile:

README.md

@@ -1,2 +1,63 @@
 # json-nested-replace
+
+[![Build Status](https://travis-ci.com/arshadkazmi42/json-nested-replace.svg?branch=master)](https://travis-ci.com/arshadkazmi42/json-nested-replace)
+[![Github Repo Size](https://img.shields.io/github/repo-size/arshadkazmi42/json-nested-replace.svg)](https://github.com/arshadkazmi42/json-nested-replace)
+[![Contributors](https://img.shields.io/github/contributors/arshadkazmi42/json-nested-replace.svg)](https://github.com/arshadkazmi42/json-nested-replace/graphs/contributors)
+[![Commit](https://img.shields.io/github/last-commit/arshadkazmi42/json-nested-replace.svg)](https://github.com/arshadkazmi42/json-nested-replace/commits/master)
+
 Searches and replace values at every level of nested json
+
+> Give us a :star: if you like our work :heart:
+
+<a href="https://www.buymeacoffee.com/arshadkazmi42" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+<a href="https://www.patreon.com/bePatron?u=15454240" target="_blank"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patron!" height="40"></a>
+
+Please consider donating, if you like my work
+
+## Install
+
+```
+$ npm install json-nested-replace
+```
+
+## Usage
+
+```javascript
+const jnestedReplace = require('json-nested-replace');
+
+const INPUT_JSON = {
+  'name': 'json-nested-replace',
+  'author': 'Arshad Kazmi',
+  'repository': {
+    'url': 'https://github.com/arshadkazmi42/json-nested-replace',
+    'language': 'js'
+  }
+};
+
+const replacedJSONValue = jnestedReplace(INPUT_JSON, 'json-nested-replace', 'jnested-replace');
+console.log(replacedJSONValue);
+// Output
+/** {
+ *   'name': 'jnested-replace',
+ *   'author': 'Arshad Kazmi',
+ *   'repository': {
+ *     'url': 'https://github.com/arshadkazmi42/jnested-replace',
+ *     'language': 'js'
+ *   }
+ * }
+ **/
+
+
+const replacedStringValue = jnestedReplace('json-nested-replace', 'json-nested', 'jnested');
+console.log(replacedStringValue)
+// Output
+// jnested-replace
+
+```
+
+## Contributing
+
+Interested in contributing to this project?
+You can log any issues or suggestion related to this library [here](https://github.com/arshadkazmi42/json-nested-replace/issues/new)
+
+Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase