[![Gem Version](https://badge.fury.io/rb/bugscriber.svg)](https://badge.fury.io/rb/bugscriber)
![test](https://github.com/nejdetkadir/bugscriber/actions/workflows/test.yml/badge.svg?branch=main)
![rubocop](https://github.com/nejdetkadir/bugscriber/actions/workflows/rubocop.yml/badge.svg?branch=main)
[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
![Ruby Version](https://img.shields.io/badge/ruby_version->=_2.7.0-blue.svg)

# Bugscriber

Bugscriber is an open source error monitoring and reporting software for Ruby on Rails.

## Installation
```ruby
gem 'bugscriber', github: 'nejdetkadir/bugscriber', branch: 'main'
```

Install the gem and add to the application's Gemfile by executing:
```bash
$ bundle add bugscriber
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
$ gem install bugscriber
```

Run the generator for creating database migration and copying localization files.
```bash
$ rails g bugscriber:install
```
## Usage
TODO: Write usage instructions here

## 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.

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 the created tag, 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/nejdetkadir/bugscriber. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nejdetkadir/bugscriber/blob/main/CODE_OF_CONDUCT.md).

## License

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 Bugscriber project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nejdetkadir/bugscriber/blob/main/CODE_OF_CONDUCT.md).