Updated comments.

Author: kelp404

README.md

@@ -39,12 +39,13 @@ sharedState.useState()
 `useSharedState` and `sharedState.useState` are the same one.
 
 ### setSharedState(state)
+Assign a new stateful value.
 #### Parameter `state`
 Type: `any`  
 Required: `required`  
-Assign a new state.
 
 ### useSharedState(path, initialState)
+Returns a stateful value, and a function to update it.
 #### Parameter `path`
 Type: `string`  
 Required: `optional`  

lib/shared-state.js

@@ -11,6 +11,10 @@ module.exports = class SharedState {
   }
 
   setState(value) {
+    /*
+    Assign a new stateful value.
+    @param value {any}
+     */
     this.state = value;
     this.setters.forEach(setter => {
       if (setter.path) {
@@ -22,6 +26,11 @@ module.exports = class SharedState {
   }
 
   generateSetState(path) {
+    /*
+    Generate a function to set state.
+    @param path {String|null}
+    @returns {Function (value) => {}}
+     */
     return value => {
       if (path) {
         if (this.state === undefined) {
@@ -41,8 +50,8 @@ module.exports = class SharedState {
             setter.set(this.state);
           }
         });
-      } else {
-        // This set is for state root.
+      } else { // Path is empty or null.
+        // This setter is for state root.
         this.state = value;
         // Call all setters because the root was updated.
         this.setters.forEach(setter => {
@@ -58,9 +67,10 @@ module.exports = class SharedState {
 
   useState(path, initialState) {
     /*
+    Returns a stateful value, and a function to update it.
     @param path {String|null} The object path.
     @param initialState {any}
-    @returns {Array<[{state: any}, {setState: function}]>}
+    @returns {Array<[{state: any}, {setState: Function}]>}
      */
     path = path == null ? '' : `${path}`;
     let sharedState = objectPath.get(this.state, path);

package.json

@@ -19,6 +19,11 @@
     "url": "https://github.com/kelp404/react-hooks-shared-state/issues"
   },
   "homepage": "https://github.com/kelp404/react-hooks-shared-state#readme",
+  "keywords": [
+    "react",
+    "react-hooks",
+    "global-state"
+  ],
   "dependencies": {
     "object-path": "0.11.4",
     "react": "16.8.6"