1 files changed, 64 insertions, 0 deletions
diff --git a/README.nfo b/README.nfo
new file mode 100644
index 0000000..6534569
--- /dev/null
+++ b/README.nfo
@@ -0,0 +1,64 @@
+┌──────────────────────────────────────────────────────────────┐
+│  H U T C H                                 [ KRZ ]   krz.sh  │
+└──────────────────────────────────────────────────────────────┘
+
+WHAT
+  ios client for sourcehut. native swiftui, iphone and ipad. uses
+  sourcehut's graphql apis. stores your personal access token in the
+  ios keychain.
+
+DOES
+  - home dashboard: assigned tickets, recent builds, projects
+  - git and mercurial repo browsing
+  - repo details: readme, refs, commits, diffs, files, artifacts,
+    settings
+  - artifact upload and deletion on release tags
+  - trackers and tickets: browse, create, edit, delete, subscribe
+  - builds: browse, detail, submit
+  - inbox and mailing list reading
+  - patchset review: cover letters, per-patch diffs, checks, version
+    chains, status changes
+  - mailing list create, settings, delete
+  - pastes: browse, create, detail
+  - profile and account settings: ssh keys, pgp keys, token
+    management, audit log
+  - email preferences for todo.sr.ht and lists.sr.ht
+  - deep links for repos, tickets, build jobs
+
+  some sr.ht services are still browser-only and open in safari.
+
+REQUIRES
+  xcode with a current ios sdk, a simulator or device, a sourcehut
+  account, and a personal access token.
+
+BUILD
+      git clone https://git.sr.ht/~ccleberg/Hutch
+
+  open in xcode, build and run. on first launch paste a token. create
+  one at https://meta.sr.ht/oauth2/personal-token.
+
+  the token is validated against meta.sr.ht before saving and stored
+  in the keychain. Reset App Data clears the token, caches, cookies,
+  and local web data.
+
+DEVELOP
+  xcode app with tests under HutchTests. run the test plan in
+  Hutch/HutchTests.xctestplan.
+
+MIRRORS
+  github:    https://github.com/krazywarez/hutch
+  sourcehut: https://sr.ht/~ccleberg/Hutch
+  kept in sync. issues or patches on either.
+
+SECURITY
+  see SECURITY.txt.
+
+LICENSE
+  0bsd. see LICENSE.
+
+CONTACT
+  [email protected]
+
+┌──────────────────────────────────────────────────────────────┐
+│  krz.sh                                                      │
+└──────────────────────────────────────────────────────────────┘