Skip to content
Browse files

update README

  • Loading branch information...
1 parent a474c30 commit 97499e446171ab65e366695caa327b431a10100f @flyerhzm committed
Showing with 7 additions and 5 deletions.
  1. +7 −5 README.md
View
12 README.md
@@ -6,25 +6,27 @@ uniform_notifier is extracted from [bullet][0], it gives you the ability to send
Install
-------
-1. install directly
+* install directly
gem install uniform_notifier
-if you want to notify by growl or xmpp, you should install them first
+ if you want to notify by growl or xmpp, you should install them first
gem install ruby-growl
gem install xmpp4r
-2. add it into Gemfile (Bundler)
+* add it into Gemfile (Bundler)
gem "uniform_notifier"
-you should add ruby-growl and xmpp4r gem if you want.
+ you should add ruby-growl and xmpp4r gem if you want.
Usage
-----
-There are two types of notifications, one is <code>inline_notify</code>, for javascript alert and javascript console notifiers, which returns a string and will be combined, the other is <code>out_of_channel_notify</code>, for rails logger, customized logger, growl and xmpp, which doesn't return anything, just send the message to the notifiers.
+There are two types of notifications,
+one is <code>inline_notify</code>, for javascript alert and javascript console notifiers, which returns a string and will be combined,
+the other is <code>out_of_channel_notify</code>, for rails logger, customized logger, growl and xmpp, which doesn't return anything, just send the message to the notifiers.
By default, all notifiers are disabled, you should enable them first.

0 comments on commit 97499e4

Please sign in to comment.
Something went wrong with that request. Please try again.