From d04e9e4dbf3899a47edf8970d52ed358ad89c428 Mon Sep 17 00:00:00 2001
From: Perreal Guillaume <guillaume.perreal@irstea.fr>
Date: Fri, 8 Mar 2019 16:11:18 +0100
Subject: [PATCH] Updated readme.MD.

---
 README.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fe8d975..a7845c8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,34 @@
 # irstea-typescript-config
 
-TSC and TSLint configuration.
\ No newline at end of file
+TSC and TSLint configuration.
+
+# Installation
+
+```bash
+npm add -D irstea-typescript-config
+```
+
+Also install the peer dependencies.
+
+# Usage
+
+In `tsconfig.json`:
+
+```json
+{
+  "extends": "node_modules/irstea-typescript-config/tsconfig.json",
+  ...
+}
+```
+
+In `tsling.json`:
+
+```json
+{
+  "extends": [
+    "tslint:recommended",
+    "irstea-typescript-config"
+  ],
+  ...
+}
+```
-- 
GitLab