README.md in messengerjs-rails-1.3.0 vs README.md in messengerjs-rails-1.3.3
- old
+ new
@@ -14,34 +14,40 @@
<img src="https://raw.github.com/HubSpot/messenger/f500e931fe7099da460aaf9b5c1013f377e40775/images/messenger_preview.png" title="Thanks for checking out Messenger!" width="400px" style="max-width: 400px"/>
</a>
[Demo and Usage](http://hubspot.github.com/messenger)
-## Requirements
+## Requirement/Dependency:
1. jQuery
2. Plays well with, but doesn't require, Bootstrap
## Installation
Add the following to your gemfile:
- gem 'messengerjs-rails'
+ gem "messengerjs-rails", "~> 1.3.0"
-Add the following directive to your application.coffee / application.js:
+Add the following directive to your application.coffee / application.js:
+ //= require jquery-rails
+ *
+ *
//= require messenger
//= require messenger-theme-future
-Add the following directive to your application.scss / application.css. There are four themes provided (future, air, block and ice), change the required stylesheet as needed.
+Add the following directive to your application.scss / application.css. There are four themes/styles provided (future, air, block and ice), change required stylesheet as needed.
*= require messenger
- *= require messenger-spinner
- *= require messenger-theme-future
+ *= require messenger-spinner
+ *= require messenger-theme-future
+## Todos
+1. Provide a Rails Middleware for replacing conventional flash messages.
+
## Versioning
Every attempt is made to mirror the currently shipping Messenger version number wherever possible.
The major, minor, and patch version numbers will always represent the Messenger version.
@@ -49,8 +55,8 @@
Feel free to open an issue ticket if you find something that could be improved.
## Acknowledgements
-Special thanks to [HubSpot](http://dev.hubspot.com/) and all Messenger contributor.
+Special thanks to [HubSpot](http://dev.hubspot.com/) and all Messenger contributors.
-Copyright [Ben Song](zbin.song@gmail.com), released under the MIT License.
+Copyright Ben Song(zbin.song@gmail.com), released under the MIT License.