Add README

README.md

@@ -1,8 +1,64 @@
-mes-aides-api
-=============
-
-[![Build Status](https://secure.travis-ci.org/sgmap/mes-aides-api.svg)](http://travis-ci.org/sgmap/mes-aides-api)
-[![Dependency Status](https://david-dm.org/sgmap/mes-aides-api.svg)](https://david-dm.org/sgmap/mes-aides-api)
-[![Dev Dependency status](https://david-dm.org/sgmap/mes-aides-api/dev-status.svg)](https://david-dm.org/sgmap/mes-aides-api#info=devDependencies&view=table)
-[![Code Climate](https://codeclimate.com/github/sgmap/mes-aides-api/badges/gpa.svg)](https://codeclimate.com/github/sgmap/mes-aides-api)
-[![Test Coverage](https://codeclimate.com/github/sgmap/mes-aides-api/badges/coverage.svg)](https://codeclimate.com/github/sgmap/mes-aides-api)
+A mapping interface between the [mes-aides](https://mes-aides.gouv.fr) [user interface](https://github.com/sgmap/mes-aides-ui) and the [OpenFisca](http://openfisca.fr) simulation engine.
+
+> Une interface de lien entre l'interface utilisateur de mes-aides et OpenFisca.
+
+If you want to run the mes-aides application, you should run [`mes-aides-ui`](https://github.com/sgmap/mes-aides-ui).
+
+
+Installing
+==========
+
+System dependencies
+-------------------
+
+### Ubuntu
+
+Make sure `build-essential`, `mongodb`, `node` v0.10, `grunt` and `bower` are installed on your machine
+
+```sh
+sudo apt-get install build-essential
+sudo apt-get install mongodb
+```
+
+### For all platforms
+
+The runtime is Node 0.10.
+
+You can for example use [`nvm`](https://github.com/creationix/nvm) to install this specific version.
+
+Once you have Node and npm installed, run:
+
+```sh
+npm install --global grunt-cli
+```
+
+
+Application
+-----------
+
+```sh
+git clone https://github.com/sgmap/mes-aides-api.git
+cd mes-aides-api
+npm install
+grunt
+```
+
+### Development mode
+
+If you need to add features to the API but want to see the impact on the application, follow the `mes-aides-ui` installation procedure.
+
+
+Usage
+-----
+
+First, start a Mongo server:
+
+```sh
+mongod --dbpath db
+```
+
+Then, start the server:
+
+```sh
+npm start
+```