Update README and docs

Author: mpeyper

README.md

@@ -13,7 +13,7 @@
 <p>Simple and complete React hooks testing utilities that encourage good testing practices.</p>
 
   <br />
-  <a href="https://react-hooks-testing-library.com/"><strong>Read The Docs</strong> (Work-In-Progress)</a>
+  <a href="https://react-hooks-testing-library.com/"><strong>Read The Docs</strong></a>
   <br />
 </div>
 
@@ -104,6 +104,9 @@ test('should increment counter', () => {
 })
 ```
 
+More advanced usage can be found in the
+[documentation](https://react-hooks-testing-library.com/usage/basic-hooks).
+
 ## Installation
 
 ```sh
@@ -116,26 +119,19 @@ npm install --save-dev @testing-library/react-hooks
 [`react`](https://www.npmjs.com/package/react) or
 [`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
 the specific version you want to test against. Generally, the installed versions for `react` and
-`react-test-renderer` should match:
+`react-test-renderer` should have matching versions:
 
 ```sh
-npm install react@^x.y.z
-npm install --save-dev react-test-renderer@^x.y.z
+npm install react@^16.9.0
+npm install --save-dev react-test-renderer@^16.9.0
 ```
 
-Both of these dependecies must be installed as at least version `16.8.0` to be compatible with
+Both of these dependecies must be installed as at least version `16.9.0` to be compatible with
 `react-hooks-testing-library`.
 
-## Documentation
-
-There are some [work-in-progress docs here](https://react-hooks-testing-library.com/). Please leave
-any feedback on them in
-[this issue](https://github.com/testing-library/react-hooks-testing-library/issues/19). PRs to
-update them are very welcome.
-
 ## API
 
-See the [API documentation](https://react-hooks-testing-library.com/reference/api).
+See the [API reference](https://react-hooks-testing-library.com/reference/api).
 
 ## Contributors
 

docs/reference/api.md renamed to docs/api-reference.md

@@ -1,6 +1,5 @@
 ---
-name: API
-menu: Reference
+name: API Reference
 route: '/reference/api'
 ---
 

docs/examples/index.md

@@ -1,6 +1,5 @@
 ---
-name: Getting Started
-menu: Introduction
+name: Introduction
 route: '/'
 ---
 
@@ -56,3 +55,34 @@ the results.
 
 1. Your hook is defined along side a component and is only used there
 2. Your hook is easy to test by just testing the components using it
+
+## Installation
+
+This module is distributed via [npm](https://www.npmjs.com/) which is bundled with
+[node](https://nodejs.org) and should be installed as one of your project's `devDependencies`:
+
+```sh
+npm install --save-dev @testing-library/react-hooks
+```
+
+### Peer Dependencies
+
+`react-hooks-testing-library` does not come bundled with a version of
+[`react`](https://www.npmjs.com/package/react) or
+[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
+the specific version you want to test against. Generally, the installed versions for `react` and
+`react-test-renderer` should have matching versions:
+
+```sh
+npm install react@^16.9.0
+npm install --save-dev react-test-renderer@^16.9.0
+```
+
+Both of these dependecies must be installed as at least version `16.9.0` to be compatible with
+`react-hooks-testing-library`.
+
+## Testing Framework
+
+In order to run tests, you will probably want to be using a test framework. If you have not already
+got one, we recommend using [jest](https://jestjs.io/), but this library should work without issues
+with any of the alternatives.

docs/introduction/getting-started.md renamed to docs/introduction.md

@@ -65,7 +65,7 @@ error that says:
 > Component definition is missing display name
 
 This is caused by the `react/display-name` rule and although it's unlikely to cause you any issues,
-it's best to take steps to remove it. If you feel strongly about not having a seperate `wrapper`
+it's best to take steps to remove it. If you feel strongly about not having a separate `wrapper`
 variable, you can disable the error for the test file but adding a special comment to the top of the
 file:
 
@@ -138,36 +138,6 @@ test('should increment counter after delay', async () => {
 [React's `Suspense`](https://reactjs.org/docs/code-splitting.html#suspense) functionality finish
 rendering.
 
-### `act` Warning
-
-When testing async hooks, you will likely see a warning from React that tells you to wrap the update
-in `act(() => {...})`, but you can't because the update is internal to the hook code, not the test
-code. This is a [known issue](https://github.com/mpeyper/react-hooks-testing-library/issues/14) and
-should have a fix when React `v16.9.0` is released, but until then, you can either just ignore the
-warning, or suppress the output:
-
-```js
-import { renderHook } from '@testing-library/react-hooks'
-import { useCounter } from './counter'
-
-it('should increment counter after delay', async () => {
-  const originalError = console.error
-  console.error = jest.fn()
-
-  try {
-    const { result, waitForNextUpdate } = renderHook(() => useCounter())
-
-    result.current.incrementAsync()
-
-    await waitForNextUpdate()
-
-    expect(result.current.count).toBe(1)
-  } finally {
-    console.error = originalError
-  }
-})
-```
-
 ## Errors
 
 If you need to test that a hook throws the errors you expect it to, you can use `result.error` to

docs/introduction/setup.md

@@ -9,17 +9,16 @@ export default {
     favicon: '/public/ram.png'
   },
   themeConfig: {
-    mode: 'dark',
+    mode: 'light',
     logo: {
       src: '/public/ram.png',
       margin: 'auto',
       width: 128
     }
   },
   menu: [
-    { name: 'Introduction', menu: ['Getting Started', 'Setup'] },
+    { name: 'Introduction' },
     { name: 'Usage', menu: ['Basic Hooks', 'Advanced Hooks'] },
-    { name: 'Examples' },
-    { name: 'Reference', menu: ['FAQ', 'Troubleshooting', 'API'] }
+    { name: 'API Reference' }
   ]
 }