README.md in danger-prose-2.0.1 vs README.md in danger-prose-2.0.3
- old
+ new
@@ -1,14 +1,13 @@
-# danger-proselint
+# danger-prose
-A description of danger-proselint.
+A description of danger-prose.
## Installation
- $ gem install danger-proselint
+ $ gem install danger-prose
-
### prose
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.
@@ -39,15 +38,15 @@
</blockquote>
#### Attributes
-<br>
+<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.
-<br>
+<tr>
`ignored_words` - Allows you to add a collection of words to skip in spellchecking.
defaults to `[""]` when it's nil.
@@ -59,5 +58,6 @@
`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.
+