README.md in boppers-uptime-0.1.2 vs README.md in boppers-uptime-0.1.3
- old
+ new
@@ -1,12 +1,9 @@
# Boppers::Uptime
A [bopper](https://github.com/fnando/boppers) to check if your sites are online.
-[![Travis-CI](https://travis-ci.org/fnando/boppers-uptime.png)](https://travis-ci.org/fnando/boppers-uptime)
-[![GPA](https://codeclimate.com/github/fnando/boppers-uptime/badges/gpa.svg)](https://codeclimate.com/github/fnando/boppers-uptime)
-[![Test Coverage](https://codeclimate.com/github/fnando/boppers-uptime/badges/coverage.svg)](https://codeclimate.com/github/fnando/boppers-uptime)
[![Gem](https://img.shields.io/gem/v/boppers-uptime.svg)](https://rubygems.org/gems/boppers-uptime)
[![Gem](https://img.shields.io/gem/dt/boppers-uptime.svg)](https://rubygems.org/gems/boppers-uptime)
## Installation
@@ -34,29 +31,44 @@
Available options:
- `name:` The target monitoring's name. Required.
- `url`: The url that will be monitored. Required.
-- `status`: The expected HTTP status (can be an array of numbers). Default to `200`.
-- `contain`: The returned URL must include that given text (may also be a regular expression).
+- `status`: The expected HTTP status (can be an array of numbers). Default to
+ `200`.
+- `contain`: The returned URL must include that given text (may also be a
+ regular expression).
- `min_failures`: Only notify after reaching this threadshold. Defaults to `2`.
- `interval`: The polling interval. Defaults to `30` (seconds).
- `timezone:` The timezone for displaying dates. Defaults to `Etc/UTC`.
-- `format`: How the time will be formatted. Defaults to `%Y-%m-%dT%H:%M:%S%:z` (e.g. `2017-10-18T19:31:29-02:00`).
+- `format`: How the time will be formatted. Defaults to `%Y-%m-%dT%H:%M:%S%:z`
+ (e.g. `2017-10-18T19:31:29-02:00`).
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/boppers-uptime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/fnando/boppers-uptime. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
-Everyone interacting in the Boppers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/boppers-uptime/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Boppers project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/boppers-uptime/blob/main/CODE_OF_CONDUCT.md).