README.md in awesome_bot-1.7.1 vs README.md in awesome_bot-1.8.0
- old
+ new
@@ -34,20 +34,20 @@
### 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
+ --allow-dupe Duplicate URLs are allowed
--allow-redirect Redirected URLs are allowed
--allow-timeout URLs that time out are allowed
--set-timeout Set connection timeout (seconds)
--white-list Comma separated URLs/domains to white list
By default, `awesome_bot` flags duplicates and URL redirects.
- Use option `--allow-dupe` to allow duplicates.
-- Use option `--allow-redirect` to all redirects.
+- Use option `--allow-redirect` to all redirects.
- You can also white list specific links that will not be flagged (for dupe or redirect). `--white-list domain1.com/post/article,domain2.com` white lists `domain1.com/post/article` and all links matching `domain2.com`.
### Examples
```shell
@@ -96,21 +96,22 @@
No issues :-)
```
## 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. 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 (or a commit is pushed). 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/status.md).
+Tip: Use the keyword `[ci skip]` in your commit title/message to selectively skip verification (if you are let's say working on a bunch of changes).
### 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).
@@ -141,10 +142,34 @@
- gem install awesome_bot
override:
- awesome_bot README.md
```
+### More
+
+Circle CI, [Codeship](https://codeship.com/), and [Semaphore CI](https://semaphoreci.com/) support running tests without adding a file to the repo (a public configuration file can however help others contribute).
+
+```
+# Codeship
+Setup
+rvm use 2.2.0 --install
+gem install awesome_bot
+
+Test
+awesome_bot README.md
+```
+
+```
+# Semaphore CI
+Language: Ruby
+Ruby version: 2.2
+Databases for: don't generate
+Setup:
+gem install awesome_bot
+awesome_bot README.md
+```
+
### Status Badge
[](https://travis-ci.org/unixorn/awesome-zsh-plugins)
To add the Travis CI build status badge above to your project, use the following code
@@ -160,24 +185,10 @@
```
- awesome_bot README.md --white-list travis-ci
```
-[](https://circleci.com/gh/dkhamsing/awesome_bot)
-
-To add the Circle CI build status badge above to your project, use the following code
-
-```
-[](https://circleci.com/gh/<username>/<project>)
-
-i.e.
-[](https://circleci.com/gh/dkhamsing/awesome_bot)
-```
-
-## Credits
-
-- [`faraday` and `parallel`](awesome_bot.gemspec)
-- [giphy](http://gph.is/XM6gMT)
+You can also add a badge for other CI tools, I recommend checking out [shields.io](http://shields.io/).
## Contact
- [github.com/dkhamsing](https://github.com/dkhamsing)
- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)