README.md in awesome_bot-1.7.0 vs README.md in awesome_bot-1.7.1
- old
+ new
@@ -1,29 +1,19 @@
# awesome_bot
-Verify links in [awesome](https://github.com/sindresorhus/awesome) projects :rocket:
+Verify links in [awesome](https://github.com/sindresorhus/awesome) projects
![](http://i.giphy.com/urvsFBDfR6N32.gif)
-[![Build Status](https://travis-ci.org/dkhamsing/awesome_bot.svg)](https://travis-ci.org/dkhamsing/awesome_bot)
+[![Build Status](https://travis-ci.org/dkhamsing/awesome_bot.svg)](https://travis-ci.org/dkhamsing/awesome_bot) [![Tests](https://img.shields.io/badge/tests-circle%20ci-brightgreen.svg)](https://circleci.com/gh/dkhamsing/awesome_bot)
[![Gem Version](https://badge.fury.io/rb/awesome_bot.svg)](https://badge.fury.io/rb/awesome_bot)
-[![](https://img.shields.io/badge/awesome-status-brightgreen.svg)](status.md)
+[![](https://img.shields.io/badge/awesome-status-brightgreen.svg)](status/status.md)
`awesome_bot` checks for valid URLs in a file, it can be used to [verify pull requests](#validate-pull-requests) updating a README.
## Installation
-Add this line to your application's Gemfile
-
- gem 'awesome_bot'
-
-And then execute
-
- $ bundle
-
-Or install it yourself as
-
$ gem install awesome_bot
## Usage
### Library
@@ -106,33 +96,30 @@
No issues :-)
```
## Validate Pull Requests
-`awesome_bot` can help you validate GitHub [pull requests](https://github.com/dkhamsing/open-source-ios-apps/pull/159), it is used by
+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. It is used by
- https://github.com/tiimgreen/github-cheat-sheet
- https://github.com/vinta/awesome-python
- https://github.com/enaqx/awesome-react
- https://github.com/vsouza/awesome-ios
- https://github.com/alebcay/awesome-shell
- https://github.com/matteocrippa/awesome-swift
-and [more](status.md).
+and [more](status/status.md).
### Travis CI
To use `awesome_bot` with Travis CI, [connect your repo](https://travis-ci.org/) and create a [`.travis.yml` file](https://github.com/dkhamsing/open-source-ios-apps/blob/master/.travis.yml).
```yml
language: ruby
-rvm:
- - 2.2
-before_script:
- - gem install awesome_bot
-script:
- - awesome_bot README.md
+rvm: 2.2
+before_script: gem install awesome_bot
+script: awesome_bot README.md
```
To turn off email notifications, add the lines below
```yml