Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
oierbravo committed Jan 2, 2013
1 parent 5cd0870 commit 37947ec
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Original file line Diff line number Diff line change
@@ -1,5 +1,25 @@
nOSCaine nOSCaine
======== ========
Nodejs OSC Sniffer


Work in progress. *It just prints all incoming OSC data*


## Installation

$ [sudo] npm install noscaine -g
### Start a sniffer

$ noscaine
*This will start a server on localhost:9999*
### More options

$ noscaine --help

Usage: noscaine [options]

Options:
-h, --help output usage information
-v, --version output the version number
-p, --port <port> specify the port [9999]
-h, --port <host> specify the host [localhost]
4 changes: 3 additions & 1 deletion package.json
Original file line number Original file line Diff line number Diff line change
@@ -1,6 +1,6 @@


{ {
"name": "nOSCascaine", "name": "noscaine",
"description": "Node OSC Sniffer", "description": "Node OSC Sniffer",
"version": "0.0.1", "version": "0.0.1",
"homepage": "https://github.com/oierbravo/nOSCaine", "homepage": "https://github.com/oierbravo/nOSCaine",
Expand All @@ -24,5 +24,7 @@
"realtime" "realtime"
,"osc" ,"osc"
,"sniffer" ,"sniffer"
,"commandline"
,"receiver"
] ]
} }

0 comments on commit 37947ec

Please sign in to comment.