Add README

This commit is contained in:
William Brawner 2024-11-17 22:13:18 -07:00
parent 8192d90126
commit ef4f301136
Signed by: wbrawner
GPG key ID: 8FF12381C6C90D35

28
README.md Normal file
View 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
```