prowly 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/README.rdoc +23 -2
  2. data/VERSION +1 -1
  3. data/bin/prowly +1 -1
  4. data/prowly.gemspec +1 -1
  5. metadata +1 -1
@@ -1,12 +1,12 @@
1
1
  = prowly
2
2
 
3
- Yet another Ruby interface to Prowl
3
+ Yet another Ruby interface to Prowl with command line utility
4
4
 
5
5
  == Installation
6
6
 
7
7
  gem install prowly
8
8
 
9
- == Usage
9
+ == Usage as a Gem
10
10
 
11
11
  Prowly.notify do |n| # :notify is an alias of :add
12
12
  n.apikey = "apikey" or n.apikeys = ["apikey_1", "apikey_2", "apikey_n"]
@@ -21,6 +21,27 @@ Yet another Ruby interface to Prowl
21
21
 
22
22
  result = Prowly.notify(notification)
23
23
 
24
+ == Usage in the command line
25
+
26
+ $prowly -h # help
27
+
28
+ $prowly -k one_apikey -a "the application" -e "the event" -d "the description" -p NORMAL
29
+ $prowly -k key_1,key_2,key_n -a "the application" -e "the event"
30
+
31
+ Options:
32
+ -k, --api-key APIKEY Prowl API Key
33
+ -d, --description DESCRIPTION Description
34
+ -e, --event EVENT Event
35
+ -p, --priority PRIORITY VERY_LOW, MODERATE, NORMAL (default), HIGH, EMERGENCY
36
+ -v, --version Print the version number and exit
37
+
38
+ If you only specify the apikey prowly will use the defaults:
39
+
40
+ :description => "I am testing Prowly, and it works!"
41
+ :event => "Prowly notification"
42
+ :application => "Prowly"
43
+ :priority => NORMAL
44
+
24
45
  == Handling the Prowl API response
25
46
 
26
47
  ON SUCCESS
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.2.0
1
+ 0.2.1
data/bin/prowly CHANGED
@@ -15,7 +15,7 @@ options = {
15
15
  :description => "I am testing Prowly, and it works!",
16
16
  :event => "Prowly notification",
17
17
  :application => "Prowly",
18
- :priority => Prowly::Notification::Priority::NORMAL}
18
+ :priority => "NORMAL"}
19
19
 
20
20
 
21
21
  opts = OptionParser.new do |opts|
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{prowly}
8
- s.version = "0.2.0"
8
+ s.version = "0.2.1"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Rafael Maga\303\261a"]
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: prowly
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - "Rafael Maga\xC3\xB1a"