Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions README

This file was deleted.

45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Ruby GNTP

Ruby library for GNTP (Growl Notification Transport Protocol)

## Installation

```
$ gem install ruby_gntp
```
Or, with bundler:

```
# Gemfile
gem 'ruby_gntp'
```

## Usage

```ruby
require 'rubygems'
require 'ruby_gntp'

# Standard way
growl = GNTP.new("Ruby/GNTP self test")
growl.register({:notifications => [{
:name => "notify",
:enabled => true,
}]})

growl.notify({
:name => "notify",
:title => "Congraturation",
:text => "Congraturation! You are successful install ruby_gntp.",
:icon => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
:sticky => true,
})

# Instant notification
GNTP.notify({
:app_name => "Instant notify",
:title => "Instant notification",
:text => "Instant notification available now.",
:icon => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
})
```