README.md in danger-prose-2.0.4 vs README.md in danger-prose-2.0.5
- old
+ new
@@ -2,10 +2,12 @@
A description of danger-prose.
## Installation
+As a pre-requisite, danger-prose requires a node environment for spell checking and a python environment for linting. So, make sure your CI environment has support for either or both of those.
+
$ gem install danger-prose
### prose
Lint markdown files inside your projects.
@@ -38,14 +40,14 @@
</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.