README.md in danger-prose-1.0.0 vs README.md in danger-prose-2.0.0

@@ -4,18 +4,46 @@
 
 ## Installation
 
     $ gem install danger-proselint
 
-## Usage
 
-Add it to your Dangerfile
 
-``` ruby
-# Look through all changed Markdown files
-markdown_files = (modified_files + added_files).select do |line|
-  line.start_with?("_posts") && (line.end_with?(".markdown") || line.end_with?(".md"))
-end
+### prose
 
-# will check any .markdown files in this PR with proselint
-proselint.lint_files markdown_files
-```
+Lint markdown files inside your projects.
+This is done using the [proselint](http://proselint.com) python egg.
+Results are passed out as a table in markdown.
+
+<blockquote>Specifying custom CocoaPods installation options
+  <pre>
+# Runs a linter with comma style disabled
+proselint.disable_linters = ["misc.scare_quotes", "misc.tense_present"]
+proselint.lint_files "_posts/*.md"
+
+# Runs a linter with all styles, on modified and added markdown files in this PR
+proselint.lint_files</pre>
+</blockquote>
+
+
+
+#### Attributes
+<tr>
+`disable_linters` - Allows you to disable a collection of linters from running. Doesn't work yet.
+You can get a list of [them here](https://github.com/amperser/proselint#checks)
+defaults to `["misc.scare_quotes", "typography.symbols"]` when it's nil.
+<tr>
+`ignored_words` - Allows you to add a collection of words to skip in spellchecking.
+defaults to `[""]` when it's nil.
+
+
+
+#### Methods
+
+`lint_files` - Lints the globbed markdown files. Will fail if `proselint` cannot be installed correctly.
+Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files.
+
+`proselint_installed?` - Determine if proselint is currently installed in the system paths.
+
+`mdspell_installed?` - Determine if mdspell is currently installed in the system paths.
+
+`check_spelling` - Runs a markdown-specific spell checker, against a corpus of `.markdown` and `.md` files.