README.md in hooray-0.0.7 vs README.md in hooray-0.0.9
- old
+ new
@@ -22,51 +22,76 @@
nofxx's iPhone | 192.168.1.77 | 64:a3:XX:XX:XX:XX
LG Electronics | 192.168.1.79 | cc:fa:XX:XX:XX:XX
TP-Link | 192.168.1.253 | f8:d1:XX:XX:XX:XX
Siemens Subscriber Networks | 192.168.1.254 | 00:0b:XX:XX:XX:XX
---
-8 devices @ 2014-12-11 13:32:04 -0200 2.85s
+8 devices @ 2014-12-11 13:32:04 -0200 2.27s
```
-Find running services:
+## Find running services
+
```
hoo list web
```
```
NAME | IP | MAC
------------------|--------------|------------------
+dsl modem | 192.168.1.1 | 64:a3:XX:XX:XX:XX
+test server | 192.168.1.75 | 64:a3:XX:XX:XX:XX
nofxx desktop | 192.168.1.77 | 64:a3:XX:XX:XX:XX
+---
+3 devices @ 2014-12-11 19:23:11 -0200 1.10s
```
Or simply by ports:
```
hoo list 80
hoo list 6777 udp
```
-Monitor:
+## Monitor
```
hoo watch
```
```
New nodes @ 2014-12-11 13:53:06 -0200
-NAME | IP | MAC
--------------|--------------|------------------
-iPhone nofxx | 192.168.1.76 | 64:a3:XX:XX:XX:XX
+NAME | IP | MAC
+-----------|--------------|------------------
+myphone | 192.168.1.76 | 64:a3:XX:XX:XX:XX
```
-Use as a lib:
+
+## Use another program
+
```
+hoo ssh myphone
+```
+
+Will execute: `ssh <ip of myphone>`
+
+You can use any program, not just ssh.
+
+
+## Use as a lib
+
+```
require 'hooray'
Hooray::Seek.lan(port, protocol).devices
Hooray::Seek.new(network, port, protocol).devices
```
+* Nil port means ICMP ping.
+* Protocol always defaults to :tcp.
+* Network defaults to LAN IP 24 bits masked.
+
+Possible protocols: tcp, udp, http, wmi & icmp (requires root).
+
+
## Why?
Bind macs or fix IP's is also boring and a per device work.
As more we use wifi/ethernet devices in our company, nmap gets boring.
Not to mention slow, there's no easy way to assign names to devices I know,
@@ -87,5 +112,9 @@
## Credits
* Ruby net-ping gem.
* Nmap`s mac precompiled prefixes.
+
+
+Hooray should work on UNIX based systems.
+Tested in Linux and OS X.