diff --git a/README.md b/README.md index a0fd27630..ae0c75ed7 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ alt="The Low-Profile Dog Hoodie Mascot" title="The Low-Profile Dog Hoodie Mascot" align="right" /> Hoodie lets you build apps [without _thinking_ about the backend](http://nobackend.org/) -and makes sure that they work great [independent from connectivity](http://offlinefirst.org/). +and makes sure that they work great [independent of connectivity](http://offlinefirst.org/). This is Hoodie’s main repository. It starts a server and serves the client API. -Read more about [how the Hoodie server works](server). +Read more about [How the Hoodie server works](server). A good place to start is our [Tracker App](https://github.com/hoodiehq/hoodie-app-tracker). You can play around with Hoodie’s APIs in the browser console and see how it -works all together in its [simple HTML & JavaScript code](https://github.com/hoodiehq/hoodie-app-tracker/tree/master/public). +works all together in its [simple HTML and JavaScript code](https://github.com/hoodiehq/hoodie-app-tracker/tree/master/public). -If you have any questions come say hi in our [chat](http://hood.ie/chat/). +If you have any questions come and say hi in our [chat](http://hood.ie/chat/). ## Setup @@ -53,7 +53,7 @@ You can find a more thorough description in our [Getting Started Guide](http://d ## Usage -`hoodie` can be used standalone or as [hapi plugin](http://hapijs.com/tutorials/plugins). +`hoodie` can be used standalone or as a [hapi plugin](http://hapijs.com/tutorials/plugins). The options are slightly different. For the standalone usage, see [Hoodie’s configuration guide](http://docs.hood.ie/en/latest/guides/configuration.html). For the hapi plugin usage, see [Hoodie’s hapi plugin usage guide](http://docs.hood.ie/en/latest/guides/hapi-plugin.html) @@ -70,7 +70,7 @@ npm install The `hoodie` test suite is run with `npm test`. You can [read more about testing Hoodie](test). -You can start hoodie for itself using `npm start`. It will serve the contents +You can start hoodie itself using `npm start`. It will serve the contents of the [public folder](public). ## Backers @@ -110,7 +110,7 @@ of the [public folder](public). ## Official Sponsors -Show your support for Hoodie and [help us sustain our inclusive community](http://hood.ie/blog/sustaining-hoodie.html). We will publicly appreciate your support and are happy to get your word out, as long as it aligns with our [Code of Conduct](http://hood.ie/code-of-conduct/). +Show your support for Hoodie and [help us sustain our inclusive community](http://hood.ie/blog/sustaining-hoodie.html). We will publicly appreciate your support and happy to get your word out as well, as long as it aligns with our [Code of Conduct](http://hood.ie/code-of-conduct/). [![](https://opencollective.com/hoodie/sponsor/0/avatar)](https://opencollective.com/hoodie/sponsor/0/website) [![](https://opencollective.com/hoodie/sponsor/1/avatar)](https://opencollective.com/hoodie/sponsor/1/website) diff --git a/docs/welcome.rst b/docs/welcome.rst index 3df39fc08..c15ad7c21 100644 --- a/docs/welcome.rst +++ b/docs/welcome.rst @@ -41,7 +41,7 @@ Open Source ~~~~~~~~~~~ Hoodie is an Open Source project, so we don’t own it, can’t sell it, and -it won’t suddenly vanish because we got aquired. The source code for +it won’t suddenly vanish because we got acquired. The source code for Hoodie is available on GitHub under the Apache License 2.0. How to proceed