Updated README.

CoralineAda · Jul 29, 2012 · c6909bb · c6909bb
1 parent 767d2c7
commit c6909bb
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 24 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2012 Corey Ehmke
+Copyright (c) 2012 Corey 'Bantik' Ehmke and Max Thom Stahl
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/README.md b/README.md
@@ -1,4 +1,18 @@
 synack
 ======
 
-A Ruby server for terminal-notifier
+Synack is a client/server wrapper for https://github.com/alloy/terminal-notifier that allows
+arbitrary messages to be sent to Mac OS X Mountain Lion's Notification Center.
+
+Note that Terminal Notifier must be installed in your Applications directory for Synack to work
+properly.
+
+To send a message to your local Notification Center, you can leave off the host and port (-h and -p)
+configuration options:
+
+  synack-client "Watson, come here, I need you."
+
+You can send messages to remote machines by specifying a host and port in the client:
+
+  synack-client -h my_remote_machine -p 11113 "I'm here, what did you want?"
+
diff --git a/README.rdoc b/README.rdoc
@@ -1,9 +1,22 @@
 = synack
 
-Description goes here.
+Synack is a client/server wrapper for https://github.com/alloy/terminal-notifier that allows
+arbitrary messages to be sent to Mac OS X Mountain Lion's Notification Center.
+
+Note that Terminal Notifier must be installed in your Applications directory for Synack to work
+properly.
+
+To send a message to your local Notification Center, you can leave off the host and port (-h and -p)
+configuration options:
+
+  synack-client "Watson, come here, I need you."
+
+You can send messages to remote machines by specifying a host and port in the client:
+
+  synack-client -h my_remote_machine -p 11113 "I'm here, what did you want?"
 
 == Contributing to synack
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -14,6 +27,6 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2012 Corey Ehmke. See LICENSE.txt for
+Copyright (c) 2012 Corey Ehmke and Max Thom Stahl. See LICENSE.txt for
 further details.
 
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
diff --git a/spec/synack_spec.rb b/spec/synack_spec.rb