Update README

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Christophe Hamerling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,23 @@
 # gitlab-teams
 
+View your defined Gitlab teams Merge Requests live-updated without effort i.e. the missing thing from Gitlab.
+
+This project is only a frontend app based on Vue and RxJS. This is still a WIP: No error handling, no tests, etc, but it works pretty well for now.
+
+At startup, you will be asked to fill a form with your `API Token` and a `Gitlab URL`:
+
+![settings](./doc/settings.png "Settings")
+
+- `API Token` is the one you can get from your Gitlab instance under `/profile/personal_access_tokens`. Create a new one with at least `api` and `read_user` scopes.
+- `Gitlab URL` is... your Gitlab instance URL. It is used to build the API endpoints to call.
+
+These two settings are stored in your browser local storage and **are never sent to someone else than your Gitlab instance**.
+
+Once set, you will be able to create (well not implemented for now but defined in `./src/teams.json`) and navigate in your teams like a boss
+
+![teams-view](./doc/teams-view.png "Teams View")
+
+
 ## Project setup
 ```
 npm install
@@ -15,25 +33,11 @@ npm run serve
 npm run build
 ```
 
-### Run your tests
-```
-npm run test
-```
-
 ### Lints and fixes files
 ```
 npm run lint
 ```
 
-### Run your end-to-end tests
-```
-npm run test:e2e
-```
-
-### Run your unit tests
-```
-npm run test:unit
-```
+## License
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+MIT