fill README.md

zeroturnaround · Oct 12, 2016 · efedb8a · efedb8a
1 parent 51d33f4
commit efedb8a
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,18 @@
-# eslint-config-zt
+# ZeroTurnaround's ESLint config
+
+## Installation
+```shell
+$ npm install --save-dev github:zeroturnaround/eslint-config-zt
+```
+
+## Usage
+```yaml
+// .eslintrc.yml
+---
+extends:
+  - "zt"
+
+rules:
+    # Some overrides
+    no-fallthrough: 0
+```