[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/satchel d27a006d33 9/9: Flesh out the readme a little m
From: |
ELPA Syncer |
Subject: |
[elpa] externals/satchel d27a006d33 9/9: Flesh out the readme a little more |
Date: |
Tue, 22 Feb 2022 16:57:52 -0500 (EST) |
branch: externals/satchel
commit d27a006d33fb144ad174408a63ce3966e79210e1
Author: Theodor Thornhill <theo@thornhill.no>
Commit: Theodor Thornhill <theo@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.
- [elpa] branch externals/satchel created (now d27a006d33), ELPA Syncer, 2022/02/22
- [elpa] externals/satchel 2514ae9c2b 3/9: Cleaning the fannypack, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel e9f5146e79 2/9: Feelin' lucky, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel 8481917960 4/9: Fanny the default-directory, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel 2f14e833a6 5/9: Require project.el, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel a6f72c3e1c 6/9: Do the fanny dance, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel 26a5ef383a 8/9: Rename to satchel, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel 3ad0a7968d 1/9: Fannypack, go!, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel 90d2ad1deb 7/9: Add some docs to the defuns, ELPA Syncer, 2022/02/22
- [elpa] externals/satchel d27a006d33 9/9: Flesh out the readme a little more,
ELPA Syncer <=