Permalink
Browse files

Edited README.markdown via GitHub

  • Loading branch information...
1 parent 7560e85 commit 589f204ed36c10ec98124dfb5762cf70d55970ec @tylerhall committed Jun 9, 2011
Showing with 17 additions and 1 deletion.
  1. +17 −1 README.markdown
View
@@ -1,3 +1,19 @@
PHP-Growl is an implementation of the [Growl notification system](http://growl.info) written in PHP.
-As a proof of concept example, I've written a [Mint](http://haveamint.com) [Pepper](http://haveamint.com/peppermill/) plugin that notifies you whenever certain events (like new referrals, unique visitors, etc) happen on your website. It's a slick way to stay on top of who is visiting your site. You can [download Growl Pepper here](http://www.haveamint.com/peppermill/pepper/49/growl/).
+As a proof of concept example, I've written a [Mint](http://haveamint.com) [Pepper](http://haveamint.com/peppermill/) plugin that notifies you whenever certain events (like new referrals, unique visitors, etc) happen on your website. It's a slick way to stay on top of who is visiting your site. You can [download Growl Pepper here](http://www.haveamint.com/peppermill/pepper/49/growl/).
+
+ <?PHP
+ $growl = new Growl($ip_address);
+
+ // Adding and registering your notifications with Growl
+ // only needs to be done once per computer. Growl will
+ // remember your app after this.
+ $growl->addNotification('Notification Name');
+ $growl->addNotification('Another Notification');
+ $growl->register();
+
+ // Send a notification
+ $growl->notify('Notification Name', 'Some Title', 'Some message to display');
+
+ // Send a second notification
+ $growl->notify('Another Notification', 'Another Title', 'Something useful I hope.');

0 comments on commit 589f204

Please sign in to comment.