Added basic Usage docs. Fixes #4

Author: mpeyper

README.md

@@ -119,9 +119,27 @@ npm install react-hooks-testing-library
 
 ## Usage
 
-```js
-// TODO: write this - see Example above for now
-```
+### `renderHook(callback[, options])`
+
+Renders a test component that will call the provided `callback`, including any hooks it contains, every time it renders.
+
+> _Note: `testHook` has been renamed to `renderHook`. `testHook` will continue work in the current version with a deprecation warning, but will be removed in a future version._
+>
+> **_You should update an usages of `testHook` to use `renderHook` instead._**
+
+#### Arguments
+
+- `callback` (`function()`) - function to call each render. This function should call one or more hooks for testing.
+- `options` (`object`):
+  - `initialProps` (`object`) - the initial values to pass to the `callback` function
+  - `wrapper` (`Component`) - A component to wrap the underlying test component, commonly used to add context providers for the `useContext` hook. The component will recieve the test component as `children` and must render it.
+
+#### Returns
+
+- `result` (`object`)
+  - `current` (`any`) - the return value of the `callback` function
+- `rerender` (`function([newProps])`) - function to rerender the test component including any hooks called in the `callback` function. If `newProps` are passed, the will replace the `initialProps` passed the the `callback` function for future renders.
+- `unmount` (`function()`) - function to unmount the test component, commonly used to trigger cleanup effects for `useEffect` hooks.
 
 ## Contributors
 

package-lock.json

@@ -17,7 +17,7 @@
     "contributors:add": "all-contributors add"
   },
   "dependencies": {
-    "react-testing-library": "^5.9.0"
+    "react-testing-library": "^6.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.2.3",
@@ -26,7 +26,7 @@
     "@babel/plugin-transform-modules-commonjs": "^7.2.0",
     "@babel/preset-env": "^7.3.1",
     "@babel/preset-react": "^7.0.0",
-    "all-contributors-cli": "^6.1.1",
+    "all-contributors-cli": "^6.1.2",
     "babel-eslint": "^10.0.1",
     "babel-plugin-module-resolver": "^3.2.0",
     "eslint": "^5.14.1",
@@ -38,8 +38,8 @@
     "prettier": "^1.16.4",
     "prettier-eslint": "^8.8.2",
     "prettier-eslint-cli": "^4.7.1",
-    "react": "^16.8.2",
-    "react-dom": "^16.8.2"
+    "react": "^16.8.3",
+    "react-dom": "^16.8.3"
   },
   "peerDependencies": {
     "react": "^16.8.0",