hipnote 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b88c777c7a4212784e43e53758f5f67dfe2653e
-  data.tar.gz: f6be4ae0f15e2e2fe2b42a25c60229e7b08d1266
+  metadata.gz: 81a6c3c3d9e6c5dd558302cbe2fa380f930dc822
+  data.tar.gz: f2c2f1181cb97a685bfe5c71d71188f4c7bcce53
 SHA512:
-  metadata.gz: e2e51803cde200ade7f1e8a8033838cbe5fd17d8f825da7bb7af9e69de2c38e22089785704505d63f45aa19d0010b02b1ad68c06924c9f292b7f6b67c258b3cc
-  data.tar.gz: 36d0eac56c006600e30d29dbdc86a8925311fcd3a7fe30fee242b80e50d191226368adb239b8c5a04e9964e50efc705b7a85e9721e65dd1c7967c070d89ae56d
+  metadata.gz: eff70f21e52659852d735ec934d247f6e09b6b05aec545aa4924c6e9d9e861eef6d85dc88ededb09cf105709ee105a45c752aac8deb7070d85e14578dd9af68b
+  data.tar.gz: e3cb680c112fe2b214e4226e6c6e384b88fc950a6192a0c82828e6897a957112d060acdbb7eab9827b7bc1e699bfb866563963d27588a5796b4bb3e0dd2f82e8

data/README.md

@@ -1,9 +1,7 @@
 # Hipnote
-
 Post a notification in hipchat
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
     gem 'hipnote'
@@ -17,11 +15,18 @@ Or install it yourself as:
     $ gem install hipnote
 
 ## Usage
-
-Make sure you set `ENV['HIPCHAT_API_TOKEN']`
+Make sure you set `ENV['HIPCHAT_API_TOKEN']`  
+`Hipnote.post([room], [message], { title: [title], color: [color], format: [format] })`  
+- `room` (where you want the message to post)
+- `message` (what you want to post)
+- `title` (title of the post) Default: 'Note'
+- `color` (color of the pos) Default: 'yellow'
+- `format` (format of the post. 'text' or 'html') Default: 'text'
+Examples:  
+`Hipnote.post('project room', 'Deploying now', title: 'Deployment')`  
+`Hipnote.post('technical comms', 'Attention, this is an <strong>alert.</strong>', color: 'red', format: 'html')`
 
 ## Contributing
-
 1. Fork it ( https://github.com/[my-github-username]/hipnote/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/hipnote.rb

@@ -6,13 +6,13 @@ module Hipnote
   @client = HipChat::Client.new(@token)
 
   def self.post(room, msg, options = {})
-    user = options[:user] || 'Note'
+    title = options[:title] || 'Note'
     format = options[:format] || 'text'
     color = options[:color] || 'yellow'
 
     if msg && room
       @client[room].send(
-        user,
+        title,
         msg,
         message_format: format,
         color: color

data/lib/hipnote/version.rb

@@ -1,3 +1,3 @@
 module Hipnote
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hipnote
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jesse La Russo