diff --git a/CHANGELOG.md b/CHANGELOG.md index 48a7258..2f91598 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ -## Unreleased +## 0.2.0 + - Handler methods are now defined as instance methods for simplicity. - Define service_id in initializer with active_handlers, instead of handler class. - Use ruby 3.0 as a base for standard/rubocop, format all code according to it. diff --git a/README.md b/README.md index aca9d3b..efb8036 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Munster + Munster is a Rails engine that provides a webhook endpoint for receiving and processing webhooks from various services. Engine stores received webhook first and later processes webhook in a separete async process. Source code is extracted from https://cheddar.me/ main service to be used in internal microservices. Code here could be a subject to change while we flesh out details. @@ -16,6 +17,7 @@ If bundler is not being used to manage dependencies, install the gem by executin $ gem install munster ## Usage + Generate migrations and initializer file. `munster:install` @@ -25,12 +27,14 @@ Mount munster engine in your routes. `mount Munster::Engine, at: "/webhooks"` ## Requirements + This project depends on two dependencies: - Ruby >= 3.0 - Rails >= 7.0 ## Error reporter + This gem uses [Rails common error reporter](https://guides.rubyonrails.org/error_reporting.html) to report any possible error to services like Honeybadger, Appsignal, Sentry and etc. Most of those services already support this common interface, if not - it's not that hard to add this support on your own. It's possible to provide additional context for every error. e.g. diff --git a/lib/munster/version.rb b/lib/munster/version.rb index ae2085f..501deff 100644 --- a/lib/munster/version.rb +++ b/lib/munster/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Munster - VERSION = "0.1.0" + VERSION = "0.2.0" end