Sha256: 13bb9711d0bc349cfe7c5536af92e477d604a31d33b6bcc8d9d3499b56083dfc
Contents?: true
Size: 1.67 KB
Versions: 8
Compression:
Stored size: 1.67 KB
Contents
# Mastodon Health-checker
mastodon_healthchecker provides a function which checks the connectability,
and other statuses of a mastodon instance.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'mastodon_healthchecker'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install mastodon_healthchecker
## Usage
```ruby
gem 'mastodon_healthchecker'
stat = MastodonHealthchecker.perform('mstdn.jp')
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then,
run `rake spec` 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/nullkal/mastodon_healthchecker. 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](http://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the MastodonHealthchecker project’s codebases, issu
urackers, chat rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/[USERNAME]/mastodon_healthchecker/blob/master/CODE_OF_CONDUCT.md).
Version data entries
8 entries across 8 versions & 1 rubygems