README.md in activehook-0.1.3 vs README.md in activehook-0.1.4

- old
+ new

@@ -1,14 +1,14 @@ # ActiveHook --- -Fast and simple webhook microservice for Ruby. **Please consider it under development at the moment.** +Fast and simple webhook delivery microservice for Ruby. **Please consider it under development at the moment.** ActiveHook provides a scalable solution to your applications webhook sending needs. Its Redis-backed, with support for forking and threading - letting it send an enormous amount of webhooks in short order. Basically a much more focused version of a job processor such as Sidekiq, DelayedJob, Resque, etc. It includes the following: -- A server for the purpose of sending webhooks. -- A mixin module for the purpose of recieving and validating webhooks. +- A server for the purpose of sending webhooks. With support for retry attempts. +- A client-side mixin module for the purpose of recieving and validating webhooks. - A piece of Rack middleware for the purpose of performing validation. ## Installation Add this line to your application's Gemfile: @@ -153,16 +153,22 @@ #### App Mode Validation Sending webhooks is one thing - ensuring they are from who we want is another. -ActiveHook includes a piece of Rack middleware for the purpose of validation. When a client attempts to validate a webhook, they are sending a message back to your server. The message includes the hooks ID as well as key. These are are then cross-referenced. If they match, we provide the AOK. +ActiveHook includes a piece of Rack middleware for the purpose of validation. When a client attempts to validate a webhook, they are sending a message back to your server. The message includes the hooks ID as well as key. These are are then cross-referenced with the server records. If they match, we provide the AOK. +We set the address that the middleware uses from our config file (App mode config described above): + +```ruby +config.validation_path = '/hooks/validate' +``` + In Rails, we would add the middleware like this: ```ruby # In config/application.rb -config.middleware.use ActiveHook::App::Middleware +config.middleware.use('ActiveHook::App::Middleware') ``` Or with Rackup files: ```ruby