=Smilies

This library consists of a notification server for linux desktops and a
correspondent ruby client API. It further contains a binary named *smile*
which runs a given shell command and reports its output and return status.

=Installation

You have to install first:
* notification-daemon >= 0.3.7
* RNotify.rb >= 0.3.3

Install the *smilies* gem itself by the following command:

  $ gem install --source=http://gems.github.com armin-joellenbeck-smilies

=Usage

Start the notification server as follows:

  $ smilies

Then run the binary *smile* with a command line as parameter, for example:

  $ smile rake

You get a notification if the command line has passed or failed with the
last line of its output (stdout and stderr together).
The full output is appended to the file <b>/tmp/<user>.smilies.output</b>.

For writing a client for the *smilies* notification server see the binary
*smile*:

  :include:bin/smile

=Support

The project home is at
GitHub[http://github.com/armin-joellenbeck/smilies/tree/master]:
  http://github.com/armin-joellenbeck/smilies/tree/master

Feel free to send:
* bug reports
* support requests
* feature requests
* patches

=Copyright

Copyright (c) 2008 by Armin Jöllenbeck
<armin@joellenbeck.net[mailto:armin@joellenbeck.net]>

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. The names of the contributors may not be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.