Skip to content

Commit

Permalink
Use playful language when describing goal
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkyMarkMcDonald committed Mar 31, 2018
1 parent 7180e00 commit efeecba
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,18 @@ A Doc[tor] for your Doc[umentation]'s invalid links.
$ gem install doc_doc
```

## Goal

Doc Doc strives to find sick links for you to treat. Doc Doc finds links that:

- lead to pages that do not load (http statuses in the 400 or 500 ranges)
- lead to pages without the elements referenced by the link's url fragment


## Usage

```
$ doc_doc 'https://github.com/SeleniumHQ/selenium/wiki/Logging' --stay-within 'https://github.com/SeleniumHQ/selenium/wiki' > invalid_links.json
$ doc_doc 'https://github.com/SeleniumHQ/selenium/wiki/Logging' > invalid_links.json
```

`invalid_links.json` identifies links that could use a little doctoring:
Expand All @@ -33,10 +40,6 @@ $ doc_doc 'https://github.com/SeleniumHQ/selenium/wiki/Logging' --stay-within 'h
}
```

Doc Doc aims to find links that:
- lead to pages that do not load (http statuses in the 400 or 500 ranges)
- lead to pages without the elements referenced by the url fragment


## Development

Expand Down

0 comments on commit efeecba

Please sign in to comment.