Skip to content

Commit

Permalink
README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Corey Ehmke committed Jul 29, 2012
1 parent c6909bb commit 029ee03
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
11 changes: 7 additions & 4 deletions README.md
Expand Up @@ -7,12 +7,15 @@ 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:
To start synack:

synack-client "Watson, come here, I need you."
synack --start

To send a message to your local Notification Center:

synack "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?"
synack -h my_remote_machine -p 11113 "I'm here, what did you want?"

11 changes: 7 additions & 4 deletions README.rdoc
Expand Up @@ -6,14 +6,17 @@ 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:
To start synack:

synack-client "Watson, come here, I need you."
synack --start

To send a message to your local Notification Center:

synack "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?"
synack -h my_remote_machine -p 11113 "I'm here, what did you want?"

== Contributing to synack

Expand Down

0 comments on commit 029ee03

Please sign in to comment.