README.md in slacked-0.7.0 vs README.md in slacked-0.8.0

- old
+ new

@@ -1,9 +1,11 @@ # Slacked -A simple and easy way to send notifications to Slack from your Rails application. A use case for this would be to post a notification in Slack when a new User is created or a certain action has been taken in your application. +This is a super simple Slack integration for Rails. A use case for this would be to post a notification in Slack when a new User is created or a certain action has been taken in your application. +Are there other gems that provide similar functionality? Yes. Do some of them provide more flexibility? Yes. The point of this was to make installing and integrating a 30 second process. + ## Getting Started Add this line to your application's Gemfile: ```ruby @@ -20,38 +22,62 @@ This will create a .env file in the root of the rails appication. Specify the Webhook Url and the message to be sent. ```ruby SLACK_WEBHOOK= "WEBHOOK_URL" -SLACK_MESSAGE= "TEST" +SLACK_DEFAULT_MESSAGE= "TEST" ``` ## Usage +Set the SLACK_WEBOOK env variable with the value of the webhook which you want to send the messages. +If you want to send a unique message in your application like 'Application is running' you can set the SLACK_DEFAULT_MESSAGE and call the message methods without sending an argument. -To send the message to slack use the method: +### To send a sync message to slack use the method: + ```ruby +Slacked.post "This is a test post" +``` + +or + +```ruby Slacked.post ``` +The last example will use the SLACK_DEFAULT_MESSAGE value +### To send an async message to slack use the method: + +```ruby +Slacked.post_async "This is a test post" +``` + +or + +```ruby +Slacked.post_async +``` +The last example will use the SLACK_DEFAULT_MESSAGE value + ## Example ```ruby class Post < ActiveRecord::Base after_create :slacked private def slacked - Slacked.post + Slacked.post 'post created!' end end ``` ## Contributors - [Sean H.](https://github.com/seathony) +- [Kaio Magalhães](https://github.com/kaiomagalhaes) ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).