diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f3220c --- /dev/null +++ b/README.md @@ -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 +```