Readme: Add file to explain design differences from spacewalk

1 files changed, 22 insertions, 0 deletions

diff --git a/README.gmi b/README.gmi
new file mode 100644
index 0000000..03a47cd
--- /dev/null
+++ b/README.gmi
@@ -0,0 +1,22 @@
+# ZachWalk: a gemini feed checker
+## A replacement for spacewalk
+
+This is just like spacewalk, except without
+* custom config file format
+* hashing page content to check for updates
+* multiple CLI commands
+* built in sorting
+* hundreds of lines of code
+
+ZachWalk operates on a gemtext file, like a pipe. It will load each gemini link, updating the date in the description.
+
+Instead of page hashing, we just parse the page for links with dates in the text. Python does all the heavy lifting for parsing these. If the page can't be updated, the existing date will be kept.
+
+```sh examples
+# you can use its own output as a template file.
+cat spacewalk.gmi | ./zachwalk.py > radar.gmi
+# output entries from your bookmarks which look like gemini feeds
+grep '^=>' bookmarks.gmi | ./zachwalk.py | grep -v 1970-01-01 > radar.gmi
+# sort your feeds by date
+echo "Most recently modified on top." | cat /dev/stdin gemlogs.gmi | ./zachwalk.py | sort -k 3 -r > gemlogs-sorted.gmi
+```