agendafs

A filesystem for your calendar.

commit 44dfa5e43b07a58410e0e7de00254a67b89917cf
parent 6b98176e48f68e468c535558fbabebf356cae026
Author: Marc Coquand <marc@coquand.email>
Date:   Mon, 28 Jul 2025 22:44:43 +0200

Docs

Diffstat:
M
CONTRIBUTING.md
 | 
2
+-
M
README.md
 | 
22
+++++++++++++++++++---

2 files changed, 20 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,7 +9,7 @@ needed](https://man.sr.ht/git.sr.ht/#referencing-tickets-in-git-commit-messages)
 ## Memory model
 
 - `memory_region` is for operation-scoped memory (get,read,write)
-- `agenda_entry` heap allocated and must be freed manually
+- `agenda_entry` is heap allocated and must be freed manually
 - Tree nodes free automatically on `free_node`
 
 Avoid mixing `memory_region` pointers with global state.
diff --git a/README.md b/README.md
@@ -57,15 +57,31 @@ Some major features are missing until ready for a beta release:
 
 - [Attachment support is missing](https://todo.sr.ht/~marcc/agendafs/2)
 - [Symlink support is missing](https://todo.sr.ht/~marcc/agendafs/11)
+- [Arbitrary xattribute support is missing](https://todo.sr.ht/~marcc/agendafs/14)
 
 ## Motivation
 
-I like plaintext notes, but found it hard to sync them and use on mobile. The beauty of caldav is that most people already have one if they're signed up an email provider, so they don't need a separate service to sync their notes.
-
-iCalender also have some interesting social features. There are a lot of opportunities to have shared notes, shared todo lists and shared calendars with friends and family this way.
+Note-taking tools like Obsidian and Logseq have great syncing capabilities,
+but they locks you into using those editors. Tools like Syncthing offers file
+syncing between devices, but require you setting up a private cloud if you want
+to backup to a remote server. Most people are signed up to an email provider,
+and thus probably already have a caldav server for their calendar. Agendafs
+leverages that as a server to sync notes, and any tool that takes advantage
+of VJOURNALs can access those notes, such as jtx board for Android.
+
+Agendafs also has a few other advantages to other note-taking tools. Other
+note-taking tools tend to work only on a single file-format, like Markdown
+or Org-mode. They leverage tags and frontmatter metadata or properties to
+link notes, which they store within the file-content itself. This has some
+advantages, but also locks you into that particular file-format. With Agendafs,
+you can store metadata in xattributes: categories (tags), classifications
+(public vs private) or any other arbitrary data. Since Agendafs is a shim
+over vdir storages, those attributes are easily backed up, which normally
+is not the case with xattributes on other file systems.
 
 ## Appendix
 
+
 ### VJOURNAL support in Nextcloud calendar
 
 To have vjournal support on Nextcloud, I needed to create the calendar manually. This is probably also required in Fastmail.