README.md in hooray-0.1.8 vs README.md in hooray-0.1.9
- old
+ new
@@ -1,35 +1,55 @@
-Hooray
-======
+# Hooray
+[](http://badge.fury.io/rb/hooray)
+[](https://coveralls.io/r/nofxx/hooray?branch=master)
+[](https://codeclimate.com/github/nofxx/hooray)
+[](https://travis-ci.org/nofxx/hooray)
+
+
+ , ________
+ /| | \ /
+ |___| __ __ ,_ __, \ /
+ | |\/ \_/ \_/ | / | | | \ /
+ | |/\__/ \__/ |_/\_/|_/ \_/|/ \/
+ /| ()
+ \|
+
+
+
Find devices around you. Fast and without hyphens.
+
+## Install
+
gem install hooray
-And use the executable `hoo`:
+## Use `hoo`
```
hoo list
```
```
-NAME | IP | MAC
-----------------------------|---------------|------------------
-Motorola Mobility | 192.168.1.70 | 34:bb:XX:XX:XX:XX
-Giga-byte Technology Co. | 192.168.1.71 | 94:de:XX:XX:XX:XX
-Veih's Android | 192.168.1.72 | 04:46:XX:XX:XX:XX
-Nery's LG | 192.168.1.73 | cc:fa:XX:XX:XX:XX
-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
+NAME | IP | MAC
+----------------------------|------------|------------------
+Motorola Mobility | 10.1.1.70 | 34:bb:XX:XX:XX:XX
+Giga-byte Technology Co. | 10.1.1.71 | 94:de:XX:XX:XX:XX
+Veih's Android | 10.1.1.72 | 04:46:XX:XX:XX:XX
+Nery's LG | 10.1.1.73 | cc:fa:XX:XX:XX:XX
+nofxx's iPhone | 10.1.1.77 | 64:a3:XX:XX:XX:XX
+LG Electronics | 10.1.1.79 | cc:fa:XX:XX:XX:XX
+TP-Link | 10.1.1.253 | f8:d1:XX:XX:XX:XX
+Siemens Subscriber Networks | 10.1.1.254 | 00:0b:XX:XX:XX:XX
---
-8 devices @ 2014-12-11 13:32:04 -0200 2.27s
+8 nodes @ 2015-01-08 00:33:07 -0200 1.27s
```
+**That's the idea: 1 second to find a device.**
+
## Find running services
```
hoo list web
```
@@ -38,11 +58,11 @@
------------------|--------------|------------------
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
+3 nodes @ 2014-12-11 19:23:11 -0200 1.10s
```
Or simply by ports:
@@ -78,12 +98,12 @@
## Use as a lib
```
require 'hooray'
-Hooray::Seek.lan(port, protocol).devices
-Hooray::Seek.new(network, port, protocol).devices
+Hooray::Seek.lan(port, protocol).nodes
+Hooray::Seek.new(network, port, protocol).nodes
```
* Nil port means ICMP ping.
* Protocol always defaults to :tcp.
* Network defaults to LAN IP 24 bits masked.
@@ -91,11 +111,11 @@
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.
+Bind macs or fix IP's is also boring and a per device/node work.
+As more we use connected (IoT) devices in our company, nmap gets boring.
Not to mention slow, there's no easy way to assign names to devices I know,
which makes OS scan/port scan a needed option most times (thus making it slower).
Also (please open a issue if you know how) even in fast mode nmap won't run in under 2s.
And, on recent updates, you need sudo for all of that.