Permalink
Browse files

fix up the readme

  • Loading branch information...
1 parent 072463f commit b4630bdf5b021378d437e62d2b6ce34a33e1c319 @pbrisbin committed Apr 27, 2012
Showing with 14 additions and 5 deletions.
  1. +14 −5 README.md
View
19 README.md
@@ -8,17 +8,26 @@ display.
This was done mostly as a learning exercise in C.
+### Installation
+
+ git clone https://github.com/pbrisbin/android-receiver
+ cd android-receiver
+ make
+
+This will compile the `android-receiver` binary in the current
+directory. Put it somewhere in `$PATH`.
+
### Usage
android-receiver [ --port <port> ] --handler <handler>
-Port is optional and defaults to 10600. The handler you specified will
-be called asynchronously with the formatted message as the first and
-only argument. You can find an example handler using dzen under `./bin`.
+Port is optional and defaults to 10600. The handler you specify will be
+called asynchronously with the formatted message as the first and only
+argument.
-You can find an example handler using dzen2 in my scripts repo.
+You can find an example handler using dzen under `./bin`.
-### Note
+### Notes
My machine is setup to block TCP broadcast packets as per Arch's "Simple
stately firewall". Rather than change this setting, I've elected to

0 comments on commit b4630bd

Please sign in to comment.