From ef4f301136236c9e3737e56274af3f0c47c2a082 Mon Sep 17 00:00:00 2001
From: William Brawner <me@wbrawner.com>
Date: Sun, 17 Nov 2024 22:13:18 -0700
Subject: [PATCH] Add README

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

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
+```