branch: externals/satchel
commit d27a006d33fb144ad174408a63ce3966e79210e1
Author: Theodor Thornhill <t...@thornhill.no>
Commit: Theodor Thornhill <t...@thornhill.no>
Flesh out the readme a little more
---
README.md | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 15ae0f8272..166866c778 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
-# Fannypack
+# Satchel
-You really can't leave your house without one, can you now?
+satchel.el is a small utility to help manage buffers and files on a working
+branch. You can place files in a satchel, which is a file with a list of files
+inside:
+
+```elisp
+;; satchel is named '~---src---satchel---#master'
+(("/home/theo/src/satchel/satchel.el")
+ ("/home/theo/src/satchel/README.md"))
+```
+
+This file is persisted, then read back in every time it is needed. The useful
+thing with this is that often you struggle with tens, if not a hundred buffers
+in your buffer list, and fuzzy finding simply gets slow because you have to
+parse the incremental search. If you manage these satchels manually you can
+maintain the 3-5 files that are most important at any given time, thus having a
+much less cluttered search space.
+
+## Satchels are separated by git branches
+This means that when you switch branches, your satchels are automatically
+updated and scoped to the work you are currently focused on.
