diff --git a/.gitignore b/.gitignore
index 8d5cfaf055..965c62ead7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -39,6 +39,7 @@ jspm_packages
#gitbook build folder
**/_book
+# IDE directory
.idea
.vscode
vscode
diff --git a/README.md b/README.md
index 0327e9c163..dd1db4998e 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,15 @@
reSolve is a full stack functional JavaScript framework.
-- [CQRS](https://martinfowler.com/bliki/CQRS.html) - independent Command and Query sides.
-- [DDD Aggregate](https://martinfowler.com/bliki/DDD_Aggregate.html) support.
-- [Event sourcing](https://martinfowler.com/eaaDev/EventSourcing.html) - using events as a source of truth and calculates read models from them.
-- Integrates with [React](https://reactjs.org) and [Redux](https://redux.js.org) for seamless development experience.
-- [React Native](https://facebook.github.io/react-native/) support.
+- 2 minutes [installation](#installation).
+- [Free and open source](https://github.com/reimagined/resolve/blob/master/LICENSE.md).
+- Flexible and clear [API](#documentation).
-## :rocket: Getting Started
+## **📑 Table of Contents**
+
+- **[🚀 Getting Started](#getting-started)**
+- **[📚 Documentation](#documentation)**
+- **[📢 Get in Touch](#get-in-touch)**
### Installation
@@ -26,10 +28,28 @@ cd my-awesome-app
npm run dev
```
-
-You can also use npm or yarn tools
+The created application is accessible using the http://localhost:3000/ and `http://:3000/` URLs (you can [change the URL settings](https://github.com/reimagined/resolve/blob/master/docs/API%20References.md)). Start learning **reSolve** with the [**ToDo List App Tutorial**](https://github.com/reimagined/resolve/blob/master/docs/Tutorials/ToDo%20List%20App%20Tutorial.md) tutorial. Use the [**documentation**](#documentation), [**tutorials**](#tutorials) and [**examples**](#examples) to learn **reSolve** more deeply.
+
+Instead of npx you can also use npm or yarn tools:
+
+- [npm](https://www.npmjs.com/)
+
+ > Note: Installing a package globally may require administrative privileges. That means you have to use the `sudo` prefix on Linux and MacOS, or start a terminal with the administrative privileges on Windows.
+
+ ```sh
+ npm i -g create-resolve-app
+ create-resolve-app my-awesome-app
+ cd my-awesome-app
+ npm run dev
+ ```
-#### [npm](https://www.npmjs.com/)
+- [yarn](https://yarnpkg.com/lang/en/)
+
+ ```sh
+ yarn create resolve-app my-awesome-app
+ cd my-awesome-app
+ yarn run dev
+ ```
> Note: Installing a package globally may require administrative privileges. That means you have to use the `sudo` prefix on Linux and MacOS, or start a terminal with the administrative privileges on Windows.
@@ -40,24 +60,43 @@ cd my-awesome-app
npm run dev
```
-#### [yarn](https://yarnpkg.com/lang/en/)
+The created application is accessible using the http://localhost:3000/ and `http://:3000` URLs (you can [change your URL settings](https://github.com/reimagined/resolve/blob/master/docs/API%20References.md)).
-```sh
-yarn create resolve-app my-awesome-app
-cd my-awesome-app
-yarn run dev
-```
+Instead of npx you can also use npm or yarn tools:
+
+- [yarn](https://yarnpkg.com/lang/en/)
+
+ ```sh
+ yarn create resolve-app nested-list-example -e nested-list
+ ```
+
+- [npm](https://www.npmjs.com/)
+
+ ```sh
+ npm i -g create-resolve-app
+ create-resolve-app nested-list-example -e nested-list
+ ```
+
+## **📚 Documentation**
+
+You can develop and run **reSolve** applications on **Linux**, **Mac** and **Windows** operating systems. It is also possible to integrate **reSolve** with the **React Native**, but this approach is currently experimental.
+
+The minimum supported **NodeJS** version is **8.10.0**.
+
+**reSolve** supports [**npx**](https://www.npmjs.com/package/npx), [**yarn**](https://yarnpkg.com/lang/en/), and [**npm**](https://www.npmjs.com/).
Your application is running at http://localhost:3000/.
-### Creating a new app with an example code
+:question: Feel free to ask questions at [Stackoverflow](https://stackoverflow.com/questions/tagged/resolvejs), using `[resolvejs]` tag.
+
+:beetle: Report bugs, issues and suggestions at [**GitHub Issues**](https://github.com/reimagined/resolve/issues)
You can create a new application with an example code using `create-resolve-app` with the `-e` flag followed by an example name. Use the `create-resolve-app -h` command to list the available [examples](./examples/).
-For instance, to run a [shopping-list](./examples/shopping-list) example, run:
+💬 Follow us on [**Twitter**](https://twitter.com/resolvejs).
```sh
npx create-resolve-app resolve-example -e shopping-list
@@ -65,9 +104,7 @@ npx create-resolve-app resolve-example -e shopping-list
## :books: Documentation
-You can find reSolve documentation in the [docs section](./docs).
-
-## :loudspeaker: Get in Touch
+🔧 Feel yourself capable of improving **reSolve**? Become one of our [**contributors**](https://github.com/reimagined/resolve/pulls)! Look through our [**Contrubutors Guide**](https://github.com/reimagined/resolve/blob/master/docs/Contributors%20Guide.md) and make a great Pull Request.
- Ask questions at Stackoverlow with [resolvejs tag](https://stackoverflow.com/tags/resolvejs)
- Submit bugs and issues to [GitHub Issues](https://github.com/reimagined/resolve/issues)
diff --git a/packages/adapters/README.md b/packages/adapters/README.md
index aa41e7e218..897bb47e48 100644
--- a/packages/adapters/README.md
+++ b/packages/adapters/README.md
@@ -6,6 +6,6 @@ This directory contains reSolve adapters:
* [Storage Adapters](storage-adapters/) - specifies where to store events
* [Read Model Adapters](readmodel-adapters/) - specifies how to store Read Models
* [Subscribe Adapters](subscribe-adapters/) - enables you to subscribe to events
-* [Api Handler Adapters](api-handler-adapters/) - specifies how to run an api handlers
+* [Api Handler Adapters](api-handler-adapters/) - specifies how to run API handlers
