diff --git a/README.md b/README.md index fe8d975bf1de1131b982d79bfd277135f6fce767..a7845c8322fa75ca99bbe72c021e6b69e0a158eb 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" + ], + ... +} +```