1 files changed, 51 insertions, 0 deletions
diff --git a/README.nfo b/README.nfo
new file mode 100644
index 0000000..e4744ad
--- /dev/null
+++ b/README.nfo
@@ -0,0 +1,51 @@
+┌──────────────────────────────────────────────────────────────┐
+│  O C T O S E N T R Y                       [ KRZ ]   krz.sh  │
+└──────────────────────────────────────────────────────────────┘
+
+WHAT
+  macos menu bar app. aggregates github security alerts (dependabot,
+  code scanning, secret scanning) across your repos into one
+  severity-ranked feed. deep-links out to github.com to act.
+
+DOES
+  - one feed across all three alert types on a single severity scale
+  - source badge, repo, github severity label, one-line summary, age
+  - click an alert to open it on github.com
+  - errors and unavailable sources shown in the popover, not hidden
+  - add or remove watched repos from the popover; a background poll
+    keeps the feed fresh while closed
+  - sign in with github via device authorization; no password or
+    token typed into the app
+  - no third-party dependencies. swiftui and urlsession.
+
+REQUIRES
+  macos 14 or later. a github account with access to the repos you
+  watch.
+
+USE
+  1. build and run.
+  2. click the shield icon, Sign in with GitHub. you get a short
+     code; Open GitHub, enter it, authorize.
+  3. click the gear to add or remove repos (owner/repo).
+  4. click an alert to open it on github.com.
+
+  an unavailable source usually means that alert type is disabled for
+  the repo or your account lacks permission, not that something broke.
+  device flow grants the security_events scope, which may not cover
+  dependabot alerts on private repos.
+
+BUILD
+  open octosentry.xcodeproj and run the octosentry scheme. targets
+  macos 14, swift 6 strict concurrency, no package dependencies.
+
+CONTRIBUTING
+  - no third-party dependencies. hard constraint.
+  - swift 6 strict concurrency stays on; new code compiles clean.
+  - match the file-per-type layout.
+
+LICENSE
+  0bsd. see LICENSE.
+
+┌──────────────────────────────────────────────────────────────┐
+│  krz.sh                                                      │
+└──────────────────────────────────────────────────────────────┘