README.md in awesome_bot-1.8.0 vs README.md in awesome_bot-1.8.1
- old
+ new
@@ -14,26 +14,10 @@
$ gem install awesome_bot
## Usage
-### Library
-
-```ruby
-irb(main):001:0> require 'awesome_bot'
-=> true
-irb(main):002:0> content = File.read 'README.md'
-=> "..."
-irb(main):003:0> result = AwesomeBot.check content
-=> #<AwesomeBot::Result:0x007fdde39f4408 @links=...>
-# AwesomeBot Result with success, statuses_issues, dupes and more
-irb(main):004:0> puts result.success ? 'No errors' : ':-('
-:-(
-```
-
-More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
-
### Command Line
awesome_bot <file> [--allow-dupe] [--allow-redirect] [--allow-timeout] [--set-timeout d] [--white-list item1,item2,..]
file Path to file, required as first argument
--allow-dupe Duplicate URLs are allowed
@@ -51,51 +35,63 @@
### Examples
```shell
$ awesome_bot README.md
> Checking links in README.md
-Links found: 56, 53 unique
- 1. https://github.com/sindresorhus/awesome
- 2. http://i.giphy.com/urvsFBDfR6N32.gif
- 3. https://travis-ci.org/dkhamsing/awesome_bot.svg
- ...
- 53. https://twitter.com/dkhamsing
-Checking URLs: ✓x→✓✓✓✓→→✓→✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓→✓✓✓✓✓✓✓✓
+Links found: 56, 37 unique
+ 01. https://github.com/sindresorhus/awesome
+ 02. http://i.giphy.com/urvsFBDfR6N32.gif
+ 03. https://travis-ci.org/dkhamsing/awesome_bot.svg
+# ...
+ 37. https://github.com/dkhamsing
+ Checking URLs: ✓✓✓→?✓→✓→→✓✓→✓✓✓→✓✓✓✓✓✓✓✓✓✓✓→✓✓✓✓✓→✓✓
-Issues :-(
-> Links
- 1. 202 http://www.rubydoc.info/gems/awesome_bot
- 2. 301 http://rubygems.org/gems/awesome_bot → https://rubygems.org/gems/awesome_bot
- 3. 302 https://badge.fury.io/rb/awesome_bot.svg → https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=6&v=1.4.0&x2=0
- 4. 302 https://badge.fury.io/rb/awesome_bot → http://rubygems.org/gems/awesome_bot
- 5. 301 https://travis-ci.org/dkhamsing/awesome_bot.svg → https://api.travis-ci.org/dkhamsing/awesome_bot.svg
- 6. 301 http://gph.is/XM6gMT → http://giphy.com/gifs/urvsFBDfR6N32
-> Dupes
- 1. https://github.com/sindresorhus/awesome
- 2. https://github.com/veggiemonk/awesome-docker
- 3. https://github.com/dotfiles/dotfiles.github.com
+ Issues :-(
+ > Links
+ 1. [L007] 301 https://travis-ci.org/dkhamsing/awesome_bot.svg → https://api.travis-ci.org/dkhamsing/awesome_bot.svg
+ 2. [L008] 302 https://badge.fury.io/rb/awesome_bot → http://rubygems.org/gems/awesome_bot
+# ...
+ > Dupes
+ 1. https://github.com/sindresorhus/awesome
+ 2. http://i.giphy.com/urvsFBDfR6N32.gif
+# ...
```
```shell
-$ awesome_bot README.md --allow-dupe --white-list fury,rubydoc,travis,codeload,gems,giphy,gph
+$ awesome_bot README.md --allow-dupe --white-list travis,badge,rubydoc,rubygems,giphy,gph
> Checking links in README.md
> Will allow duplicate links
-> White list links matching: fury, rubydoc, travis, codeload, gems, giphy, gph
-Links found: 51, 23 white listed, 42 unique
- 1. https://github.com/sindresorhus/awesome
- 2. https://twitter.com/dkhamsing
- ...
-Checking URLs: ✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓
-Checking white listed URLs: →→✓x✓✓✓→✓✓→→→
+> White list links matching: travis, badge, rubydoc, rubygems, giphy, gph
+Links to check: 21, 27 white listed, 16 unique
+ 01. https://github.com/sindresorhus/awesome
+ 02. https://circleci.com/gh/dkhamsing/awesome_bot
+ 03. https://github.com/dkhamsing
+# ...
+Checking URLs: ✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓
+Checking white listed URLs: ✓✓✓→→?✓→→✓→✓→✓→✓→✓
> White listed:
- 1. 301 http://rubygems.org/gems/awesome_bot → https://rubygems.org/gems/awesome_bot
- 2. 301 http://gph.is/XM6gMT → http://giphy.com/gifs/urvsFBDfR6N32
- 3. 200 http://i.giphy.com/urvsFBDfR6N32.gif
- ...
-
+ 01. [L005] 200 http://i.giphy.com/urvsFBDfR6N32.gif
+ 02. [L007] 200 https://img.shields.io/badge/tests-circle%20ci-brightgreen.svg
+# ...
No issues :-)
```
+
+### Library
+
+```ruby
+irb(main):001:0> require 'awesome_bot'
+=> true
+irb(main):002:0> content = File.read 'README.md'
+=> "..."
+irb(main):003:0> result = AwesomeBot.check content
+=> #<AwesomeBot::Result:0x007fdde39f4408 @links=...>
+# AwesomeBot Result with success, statuses_issues, dupes and more
+irb(main):004:0> puts result.success ? 'No errors' : ':-('
+:-(
+```
+
+More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
## Validate Pull Requests
Does your GitHub README contain a lot of links? `awesome_bot` can help you validate them when a [pull request](https://github.com/dkhamsing/open-source-ios-apps/pull/159) is created (or a commit is pushed). It is used by: