From 4036b62c2cc7ac5b7d073846e78e6e3999d5f151 Mon Sep 17 00:00:00 2001
From: rodrigo4244 <rodrigo4244@users.noreply.github.com>
Date: Wed, 13 Sep 2017 17:01:04 -0300
Subject: [PATCH] docs: bootstrap README

---
 README.md | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index beaa0ab..397299d 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,19 @@
 # inv-lint
+> Invisible Technologies Eslint Package
 
-# Setup
+# Install
 
-1. Add `WEBHOOK_PATH` environmental variable to your project on circleCI.
+```
+yarn add -D invisible-tech/inv-lint
+# or
+npm install -D invisible-tech/inv-lint
+```
 
-    To do this you will have to:
-    
-    - Go to `https://circleci.com/gh/invisible-tech/<your-project-name>/edit#env-vars` (replace \<your-project-name\>, e.g. gear)
-    - Click on `Import Variable(s)`.
-    - Select `WEBHOOK_PATH`.
-      - If you don't have permission to do that, ask your superior to do it!
+# Usage
+
+1. Add `inv-lint` to your lint script on `package.json`
+  ```json
+  // It should look something like:
+  "lint": "inv-lint",
+  "pretest": "yarn run lint",
+  ```