README.md in slack_messaging-1.0.1 vs README.md in slack_messaging-1.1.0
- old
+ new
@@ -1,31 +1,44 @@
# Slack Messaging [](https://travis-ci.org/emmasax1/slack_messaging) [](https://codeclimate.com/github/emmasax1/slack_messaging)
This is a simple project designed to post messages to a given Slack channel as a bot.
-### Usage
+## Installation
-First, run:
+Add this line to your application's Gemfile:
+```ruby
+gem 'slack_messaging'
```
-gem install bundler
-bundle install
-```
-Then, the project should be ready to go! However, it won't necessarily know where to print to Slack. So, this project requires a config file called `~/.slack_messaging.yml`. The config file should look like this:
+And then execute:
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install slack_messaging
+
+### Usage
+
+This project requires a config file that should look like this:
+
```
slack:
channel: "#[AWESOME CHANNEL NAME]"
username: [AWESOME USER NAME]
webhook_url: [WEBHOOK URL]
icon_emoji: ":[SOME EMOJI]:"
```
+The default is for the file to be named `~/.slack_messaging.yml`, but a different path can be passed in like this:
+
+ $ slack-messaging --config="/PATH/TO/FILE/config.yml" slack
+
To obtain the webhook url, go to [this link](https://api.slack.com/incoming-webhooks).
-Okay, now the project will _actually_ be ready to rock and roll.
+Okay, now the project will be ready to rock and roll.
To print a friendly message to Slack, run:
```
slack-messaging slack
@@ -60,5 +73,20 @@
1. Fork it (https://github.com/emmasax1/slack_messaging/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
+
+### RubyGems
+To make a new version and push to RubyGems:
+
+1. Update the CHANGELOG.markdown with the new version and changes made
+
+3. Run `git add -A && git commit -m "Updating Changelog for [version number]"`
+
+2. Update `lib/slack_messaging/version.rb` with the new version number
+
+4. Run `git add -A && git commit -m "Version Bump" && git push`
+
+5. Run `gem build slack_messaging.gemspec && gem push *.gem`
+
+6. Run `rm *.gem`