diff --git a/README.md b/README.md
index 4dc56b6..3779554 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,40 @@
![alt text](docs/react-jsonpath-editor.png "React json path editor")
+## Usage
+
+install the dependency using `npm` or `yarn`
+
+```
+npm i --save react-jsonpath-editor
+```
+
+
+```
+yarn add react-jsonpath-editor
+```
+
+```javascript
+import React, {Component} from 'react'
+import JsonPathEditor from 'react-jsonpath-editor';
+
+class App extends Component {
+ render() {
+ return
+
+
;
+ }
+}
+```
+
+## Properties
+
+| Props | Type | Required | Description |
+|:-------------:|:-------------:|:---------:|-------------------------------------------------------|
+| inputProps | object | false | Properties passed down to the input |
+| value | string | false | input default value |
+| json | object | false | json to test the json path and provide autocompletion |
+| onChange | function | false | callback called when jsonPath changed |
[build-badge]: https://img.shields.io/travis/JeanBaptisteWATENBERG/react-jsonpath-editor/master.png?style=flat-square
[build]: https://travis-ci.org/JeanBaptisteWATENBERG/react-jsonpath-editor
diff --git a/package.json b/package.json
index b8e0c3b..c781c57 100644
--- a/package.json
+++ b/package.json
@@ -33,11 +33,14 @@
"react": "^16.4.0",
"react-dom": "^16.4.0"
},
- "author": "",
- "homepage": "",
+ "author": "Jean-Baptiste WATENBERG",
+ "homepage": "https://github.com/JeanBaptisteWATENBERG/react-jsonpath-editor",
"license": "MIT",
- "repository": "",
+ "repository": "https://github.com/JeanBaptisteWATENBERG/react-jsonpath-editor",
"keywords": [
- "react-component"
+ "react-component",
+ "jsonpath",
+ "react",
+ "component"
]
}