Start fleshing out the readme now that I've done my MVP stuff

1 files changed, 32 insertions, 7 deletions

diff --git a/readme.org b/readme.org
index ee9c6b1..64152ea 100644
--- a/readme.org
+++ b/readme.org
@@ -1,17 +1,38 @@
 #+TITLE: Shackle Shell
+#+AUTHOR: Justin Wernick
 
 A shell intended for restricted access on a version control repo server.
 
-This is intended as a replacement for [[https://git-scm.com/docs/git-shell][Git Shell]], but with the additional
-commands I want to create new repos, rearrange things, etc built
-in.
+This is intended as a replacement for [[https://git-scm.com/docs/git-shell][Git Shell]], but with a few opinionated
+differences:
 
-It will also limit access to only git repos within the file hierarchy I use.
+- Additional commands, like creating new repos, are built in. No extension with
+  shell scripts.
+- Strict enforcement of a specified directory structure. Git push / pull
+  commands only work for these paths. New repos are created in these paths.
+  - Private git repos are created in =~/git/<username>/<reponame>.git=
+  - Shared git repos are created in =~/git/<groupname>/<reponame>.git=
+- Better interactive UX than Git Shell, including:
+  - Command history (limited to the current session).
+  - Emacs-style shortcuts (eg =Ctrl+a= to move cursor to the beginning of line).
+  - Docs available for all commands, available in the shell itself.
+- (coming soon!) Support for other other version control systems.
 
-Additionally, this may support passthrough for other version control system like
-Pijul.
+* Getting Started
 
-* Roadmap
+** Usage
+
+# TODO
+
+** Installation
+
+# TODO
+
+* Development Guide
+
+# TODO
+
+* Roadmap / Issue Tracker TODO list
 
 ** MVP
 
@@ -55,3 +76,7 @@ Pijul.
 - [ ] pijul fetch and pijul push
 - [ ] pijul support on other commands
 - [ ] project website
+
+* License
+
+# TODO