Merge pull request #3 from chadhietala/fix-readme

Fixing README and adding a list rules we want to implement

Author: chadhietala

README.md

@@ -12,26 +12,40 @@ This adds more guard rails for Ember. Just because something "works" does not me
 # Why
 As we've scaled out to over hundreds developers and hundrends of lines of code it has become clear that more "development time" guidance is required. While the guides do a good job about getting started, it's good to have some friction to make sure the app code is aligned with how Ember works.
 
-## Installation
+## Using the plugin with Ember CLI
 
-* `git clone <repository-url>` this repository
-* `cd ember-strict-mode`
-* `npm install`
-* `bower install`
+### Installation
 
-## Running
+Install the plugin as a dev dependency in your Ember CLI project.
 
-* `ember serve`
-* Visit your app at [http://localhost:4200](http://localhost:4200).
+```
+npm install --save-dev eslint-plugin-ember-suave
+```
 
-## Running Tests
+This will make the plugin available to ESLint.
 
-* `npm test` (Runs `ember try:each` to test your addon against multiple Ember versions)
-* `ember test`
-* `ember test --server`
+Next, install the [ember-cli-eslint](https://github.com/ember-cli/ember-cli-eslint) addon so that your app can be linted during development and testing. This will also uninstall [ember-cli-jshint](https://github.com/ember-cli/ember-cli-jshint) since there is no need to have both linters running at the same time.
 
-## Building
+```
+ember install ember-cli-eslint
+```
 
-* `ember build`
+### Configuration
 
-For more information on using ember-cli, visit [http://ember-cli.com/](http://ember-cli.com/).
+The `ember-cli-eslint` addon blueprint generates a .eslintrc.js configuration file at the root of the project.
+
+Add the plugin's [recommended](https://github.com/chadhietala/eslint-plugin-ember-best-practices/blob/master/config/recommended.js) configuration to the list of extensions:
+
+```
+// .eslintrc.js
+
+module.exports = {
+  // ...
+  extends: [
+    'eslint:recommended',
+    'plugin:ember-best-practices/recommended'
+  ],
+  rules: {
+  }
+};
+```

RULES.md

@@ -0,0 +1,11 @@
+# Pending Rules
+
+These are rules we would like to enforce:
+
+no-attrs-snapshots
+no-timers
+no-mixins
+no-sub-classes
+detect-stateless-service
+eager-injections
+no-send-action