Skip to content

Commit

Permalink
Merge pull request #172 from amperser/readme
Browse files Browse the repository at this point in the history
Beef up the README
  • Loading branch information
suchow committed Sep 28, 2015
2 parents cbbde72 + fd4290a commit 4361a42
Showing 1 changed file with 41 additions and 37 deletions.
78 changes: 41 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="logo.png" alt="proselint logo" width="200">

![Version](https://img.shields.io/badge/version-v0.1.0-yellow.svg)
![Version](https://img.shields.io/badge/version-v0.2.0-yellow.svg)
[![Build Status](https://magnum.travis-ci.com/amperser/proselint.svg?token=ygVLzsadbn3UbxEk8GzT&branch=master)](https://magnum.travis-ci.com/amperser/proselint)
[![Code Climate](https://codeclimate.com/repos/5538989ee30ba0793100090f/badges/e10a2fe18a9256d69e2a/gpa.svg)](https://codeclimate.com/repos/5538989ee30ba0793100090f/feed)
[![Coverage Status](https://coveralls.io/repos/amperser/proselint/badge.svg?branch=master&service=github&t=2lhJpx)](https://coveralls.io/github/amperser/proselint?branch=master)
Expand All @@ -15,10 +15,6 @@

To get this up and running as a command line utility, run `python setup.py develop` from inside the root directory.

```
$ python setup.py develop
```

### API

```js
Expand Down Expand Up @@ -75,10 +71,12 @@ You can disable any of the checks by modifying `.proselintrc`.
| ID | Description |
| ----- | --------------- |
| `butterick.symbols` | Using the right symbol |
| `carlin.filth` | Words to avoid |
| `consistency.spacing` | Consistent sentence spacing |
| `consistency.spelling` | Consistent use of British vs. American spelling |
| `garner.a_vs_an` | Using 'a' vs. 'an' as a determiner |
| `garner.airlinese ` | Avoiding jargon of the airline industry |
| `garner.airlinese` | Avoiding jargon of the airline industry |
| `garner.am_pm` | Using the right form for the time of day |
| `garner.animal_labels` | Likening things to animals using fun words |
| `garner.archaism` | Avoiding archaic forms |
| `garner.back_formations` | Avoiding needless backformations |
Expand All @@ -91,44 +89,50 @@ You can disable any of the checks by modifying `.proselintrc`.
| `garner.jargon` | Avoiding miscellaneous jargon |
| `garner.malaproprisms` | Avoiding common malaproprisms |
| `garner.many_a` | Many a singular |
| `garner.misspelling` | Avoiding common misspellings missed by spellcheck |
| `garner.misspelling` | Avoiding common misspellings missed by spell-check |
| `garner.mixed_metaphors` | Not mixing metaphors |
| `garner.needless_variants` | Using the preferred form |
| `garner.oxymorons` | Aoviding oxymorons |
| `garner.oxymorons` | Avoiding oxymorons |
| `garner.preferred_forms` | Miscellaneous preferred forms |
| `garner.punctuation` | Using the right punctuation |
| `garner.redundancy` | Avoiding redunancy |
| `garner.redundancy` | Avoiding redundancy |
| `garner.sexism` | Avoiding sexist language |
| `gowers.overworked_metaphors` | Overworked metaphors |
| `inc.corporate_speak` | Avoiding corporate buzzwords |
| `leonard.exclamation` | Avoiding hyperbolic use of exclamation |
| `leonard.hell` | Avoiding a common cliche |
| `leonard.hell` | Avoiding a common cliché |
| `lilienfeld.terms_to_avoid` | Avoiding misused psychological terms |
| `misc.annotations` | Catching annotations left in the text |
| `misc.chatspeak` | ... |
| `misc.credit_card` | |
| `misc.currency` | |
| `misc.hyperbolic` | |
| `misc.link_checker` | |
| `misc.password` | |
| `nordquist.redundancy` | |
| `norris.denizen_labels` | |
| `ogilvy.pretension` | |
| `orwell.debased` | |
| `palahniuk.suddenly` | |
| `pinker.apologizing` | |
| `pinker.hedging` | |
| `pinker.latin` | |
| `pinker.metaconcepts` | |
| `pinker.narcisissm` | |
| `pinker.scare_quotes` | |
| `strunk_white.composition` | |
| `strunk_white.greylist` | |
| `strunk_white.usage` | |
| `twain.damn` | |
| `wallace.tense_present` | |
| `wallace.uncomparables` | |
| `write_good.cliches` | |
| `write_good.lexical_illusions` | |
| `write_good.weasel_words` | |
| `wsj.athletes` | |
| `misc.chatspeak` | Avoiding lolling and other chatspeak |
| `misc.credit_card` | Keeping credit card numbers secret |
| `misc.currency` | Avoiding redundant currency symbols |
| `misc.hyperbolic` | Not being hyperbolic |
| `misc.link_checker` | Linking only to existing sites |
| `misc.password` | Keeping passwords secret |
| `misc.whence` | Usage of the word "whence" |
| `nfl.naughty_words` | Avoiding words banned by the NFL |
| `nordquist.redundancy` | Avoiding redundancy and saying things twice |
| `norris.denizen_labels` | Using the right denizen label |
| `ogilvy.pretension` | Avoiding being pretentious |
| `orwell.debased` | Avoiding debased language |
| `palahniuk.suddenly` | Avoiding the word suddenly |
| `pinker.apologizing` | Being confident |
| `pinker.hedging` | Not hedging |
| `pinker.latin` | Avoiding overuse of Latin phrases |
| `pinker.metaconcepts` | Avoiding overuse of metaconcepts |
| `pinker.narcisissm` | Talking about the subject, not its study |
| `pinker.scare_quotes` | Using scare quotes only when needed |
| `strunk_white.composition` | Avoiding wordy phrases |
| `strunk_white.greylist` | Words to avoid |
| `strunk_white.usage` | Misc. usage recommendations |
| `twain.damn` | Avoiding the word "very" |
| `wallace.tense_present` | Misc. advice |
| `wallace.uncomparables` | Not comparing uncomparables |
| `write_good.cliches` | Avoiding cliches |
| `write_good.lexical_illusions` | Avoiding lexical illusions |
| `write_good.weasel_words` | Avoiding weasel words |
| `wsj.athletes` | Spelling the names of athletes correctly |

### Contributing

We'd love to accept your patches and contributions to improve `proselint`. Learn more about how to contribute in [CONTRIBUTING.md](./CONTRIBUTING.md).

0 comments on commit 4361a42

Please sign in to comment.