docs: enhance readme

octo-woapi · Nov 20, 2018 · d9caf2d · d9caf2d
1 parent ff6c86c
commit d9caf2d
Showing 1 changed file with 27 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,22 @@
-# API with Vanilla
+API with Vanilla
+===
 
 > Example of a Node.js API without framework.
 
-## Getting started
+
+Status
+---
+
+> Runnable
+
+
+Getting started
+---
+
+Install the dependencies
+```
+$ npm install
+```
 
 Run the tests
 ```
@@ -13,3 +27,14 @@ Start the project
 ```
 $ npm start # default port is 3000
 ```
+
+
+Features
+---
+
+Based on the [Katapi](https://github.com/octo-woapi/katapi) kata!
+
+
+License
+---
+MIT