Add README
This commit is contained in:
parent
8192d90126
commit
ef4f301136
1 changed files with 28 additions and 0 deletions
28
README.md
Normal file
28
README.md
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
# ntgr
|
||||||
|
|
||||||
|
`ntgr` is a TUI to facillitate interactions with Netgear Nighthawk routers.
|
||||||
|
Currently it only suppports listing out the connected devices. While viewing the
|
||||||
|
list of attached devices, one can press `i` to sort by IP address or `n` to sort
|
||||||
|
by name (default).
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Without cloning the repo, one can run the following to install `ntgr`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go install git.wbrawner.com/wbrawner/ntgr/cmd/ntgr@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
If you've already clone the repo, you can use the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make install
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
To build, run the following:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make
|
||||||
|
```
|
Loading…
Reference in a new issue