GitBook: [master] 24 pages modified

Author: ghengeveld

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Table of contents
+
+* [README](README.md)
+* [examples](examples/README.md)
+  * [README](examples/with-react-router.md)
+  * [React Async with Next.js](examples/with-nextjs.md)
+  * [Movie app using React Async](examples/movie-app.md)
+  * [Using React Async with TypeScript](examples/with-typescript.md)
+  * [Basic fetch with useAsync hook](examples/basic-hook.md)
+  * [Custom React Async instance](examples/custom-instance.md)
+  * [Abortable fetch with React Async](examples/with-abortcontroller.md)
+  * [Basic fetch with React Async](examples/basic-fetch.md)
+* [React Async codemods](codemods.md)
+* [Contributing to React Async](contributing.md)
+

README.md

@@ -1,33 +1,28 @@
 # React Async codemods
 
-These codemods enable you to automatically upgrade your codebase to handle breaking changes in
-React Async's API.
+These codemods enable you to automatically upgrade your codebase to handle breaking changes in React Async's API.
 
 ## Warning
 
-Be aware: **codemods transform your source code in place**. Make sure that your files are in
-version control before running a codemod.
+Be aware: **codemods transform your source code in place**. Make sure that your files are in version control before running a codemod.
 
-These codemods come without warranty. They will work fine most of the time, but you should always
-verify their output. Also, **do not run a codemod more than once.**
+These codemods come without warranty. They will work fine most of the time, but you should always verify their output. Also, **do not run a codemod more than once.**
 
 ## Running a codemod
 
-These codemods are based on [jscodeshift](https://github.com/facebook/jscodeshift). Refer to their
-docs for specifics.
+These codemods are based on [jscodeshift](https://github.com/facebook/jscodeshift). Refer to their docs for specifics.
 
 ```bash
 npx jscodeshift <target_dir> -t <transform_script>
 ```
 
-Where `<target_dir>` should be replaced with the path to your project's source directory and
-`<transform_script>` should be replaced by the URL of the codemod.
+Where `<target_dir>` should be replaced with the path to your project's source directory and `<transform_script>` should be replaced by the URL of the codemod.
 
 For example:
 
 ```bash
 npx jscodeshift . -t https://raw.githubusercontent.com/async-library/react-async/master/codemods/v6.js
 ```
 
-This will apply the codemod for [v6](https://github.com/async-library/react-async/blob/master/codemods/v6.js)
-to the current working directory (`.`).
+This will apply the codemod for [v6](https://github.com/async-library/react-async/blob/master/codemods/v6.js) to the current working directory \(`.`\).
+

SUMMARY.md

@@ -6,16 +6,16 @@ This repo relies on Yarn workspaces, so you should [install](https://yarnpkg.com
 
 ## Development guide
 
-Please have the **_latest_** stable versions of the following on your machine
+Please have the _**latest**_ stable versions of the following on your machine
 
-- node
-- yarn
+* node
+* yarn
 
 ### Initial setup
 
 To start working on React Async, clone the repo and bootstrap the project:
 
-```sh
+```bash
 git clone https://github.com/async-library/react-async.git
 cd react-async
 yarn && yarn bootstrap && yarn test
@@ -25,18 +25,17 @@ yarn && yarn bootstrap && yarn test
 
 We use Storybook as a development environment, particularly for the DevTools. Spin it up using:
 
-```sh
+```bash
 yarn storybook
 ```
 
-This should open up Storybook in a browser at http://localhost:6006/
-Run it side-by-side with `yarn test --watch` during development. See [Testing](#testing).
+This should open up Storybook in a browser at [http://localhost:6006/](http://localhost:6006/) Run it side-by-side with `yarn test --watch` during development. See [Testing](contributing.md#testing).
 
 ### Linting
 
 Use `yarn lint` to verify your code style before committing. It's highly recommended to install the Prettier and ESLint plugins for your IDE. Travis CI will fail your build on lint errors. Configure VS Code with the following settings:
 
-```plaintext
+```text
 "eslint.autoFixOnSave": true,
 "eslint.packageManager": "yarn",
 "eslint.options": {
@@ -59,15 +58,15 @@ This should enable auto-fix for all source files, and give linting warnings and
 
 Use the following command to test all packages in watch mode. Refer to the [Jest CLI options](https://jestjs.io/docs/en/cli#options) for details.
 
-```sh
+```bash
 yarn test --watch
 ```
 
 In general, this is sufficient during development. Travis CI will apply a more rigorous set of tests.
 
 #### Testing for compatibility
 
-```sh
+```bash
 yarn test:compat
 ```
 
@@ -79,7 +78,7 @@ In the `examples` folder, you will find sample React applications that use React
 
 To run sample examples on your local environments
 
-```sh
+```bash
 yarn build:examples
 yarn test:examples
 yarn start:examples
@@ -88,3 +87,4 @@ yarn start:examples
 ### Resolving issues
 
 Sometimes your dependencies might end up in a weird state, causing random issues, especially when working with the examples. In this case it often helps to run `yarn clean -y && yarn bootstrap`. This will delete `node_modules` from all packages/examples and do a clean install.
+

codemods/README.md codemods.mdcodemods/README.md renamed to codemods.md

@@ -0,0 +1,2 @@
+# examples
+

CONTRIBUTING.md contributing.mdCONTRIBUTING.md renamed to contributing.md

@@ -0,0 +1,6 @@
+# Basic fetch with React Async
+
+This demonstrates a very simple HTTP GET using `fetch`, wrapped with React Async.
+
+ [![](https://img.shields.io/badge/live-demo-blue.svg)](https://react-async.async-library.now.sh/examples/basic-fetch)
+

examples/README.md

@@ -0,0 +1,6 @@
+# Basic fetch with useAsync hook
+
+This demonstrates how to use the `useAsync` hook.
+
+ [![](https://img.shields.io/badge/live-demo-blue.svg)](https://react-async.async-library.now.sh/examples/basic-hook)
+