Fix typo in README.

Add CONTRIBUTING guide.
retaxJS · Apr 22, 2016 · 6eb5e67 · 6eb5e67
1 parent 7b00bb7
commit 6eb5e67
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing
+## Install the project
+
+```
+git clone
+nvm use
+npm install
+npm run typings
+npm start
+```
+
+## Before creating a merge request
+```
+npm test
+```
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ optionnal **retax modules**.
 Check theses projects to learn how to use retax: [retax-client][retax-client-link] or [retax-server][retax-server-link].
 
 
-## How retax works?
+## What retax does?
 ### Bootstrapping
 When you bootstrap a retax application
 (whether on client or on server: the code of **retax-core** is 100% universal),
@@ -36,7 +36,7 @@ The rendering is delegated to these modules [retax-client][retax-client-link] or
 **retax-core** literally just *build* the application.
 
 ### Provide a inversion of control container to retax modules
-Your application will be wrapped by a component `<RetaxProvider />`. This component expose to its children a IoC container.
+Your application will be wrapped by a component `<RetaxProvider />`. This component exposes to its children a IoC container.
 This allows them to use dependency injection. This is highly used by all **retax modules**.