Permalink
Browse files

Updated README.

  • Loading branch information...
1 parent 767d2c7 commit c6909bba082e10ced3451d08fa39c34bbad5a749 Corey Ehmke committed Jul 29, 2012
Showing with 32 additions and 24 deletions.
  1. +1 −1 LICENSE.txt
  2. +15 −1 README.md
  3. +16 −3 README.rdoc
  4. +0 −12 spec/spec_helper.rb
  5. +0 −7 spec/synack_spec.rb
View
@@ -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
View
@@ -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?"
+
View
@@ -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.
View
@@ -1,12 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'synack'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-
-end
View
@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Synack" do
- it "fails" do
- fail "hey buddy, you should probably rename this file and start specing for real"
- end
-end

0 comments on commit c6909bb

Please sign in to comment.