Add documentation

Author: BrainMaestro

Diff for: README.md

@@ -0,0 +1,54 @@
+# eslint-plugin-optimize-regex
+
+Optimize regex literals
+
+## Installation
+
+You'll first need to install [ESLint](http://eslint.org):
+
+```
+$ npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-optimize-regex`:
+
+```
+$ npm install eslint-plugin-eslint-optimize-regex --save-dev
+```
+
+**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin--optimize-regex` globally.
+
+## Usage
+
+Add `optimize-regex` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+    "plugins": [
+        "optimize-regex"
+    ]
+}
+```
+
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+    "rules": {
+        "optimize-regex/optimize-regex": "error"
+    }
+}
+```
+
+## Rules
+
+* [optimize-regex](./docs/rules/optimize-regex.md)
+
+## Inspiration
+
+* [regexp-tree](https://github.com/DmitrySoshnikov/regexp-tree)
+
+## License
+
+MIT © Ezinwa Okpoechi

Diff for: docs/rules/optimize-regex.md

@@ -0,0 +1,24 @@
+# Optimize regex literals (optimize-regex)
+
+This rule enforces an idiomatic and sometimes clearer usage of regexes.
+
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```js
+
+const re = /[a-zA-Z_0-9][A-Z_\da-z]*\e{1,}/
+
+```
+
+Examples of **correct** code for this rule:
+
+```js
+
+const re = /\w+e+/
+
+```
+
+The two regexes have the exact same functionality.

Diff for: package.json

@@ -1,7 +1,8 @@
 {
   "name": "eslint-plugin-optimize-regex",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Optimize regex literals",
+  "repository": "BrainMaestro/eslint-plugin-optimize-regex",
   "keywords": [
     "eslint",
     "eslintplugin",