agendafs
A filesystem for your calendar.
git clone git://mccd.space/agendafscommit 3a643f8f620cd606d5c83b3acfc938712a04151d
parent b4ec9ab781120b4d2dee641f66b1717020513e84
Author: Marc Coquand <marc@coquand.email>
Date: Fri, 1 Aug 2025 11:44:16 +0200
README
Diffstat:
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -5,13 +5,14 @@

-Agendafs is a FUSE-based filesystem for writing notes. It creates a shim for [vdir storages](https://pimutils.org/specs/vdir/), allowing you to write notes as regular files and synchronize them back to a caldav server. It supports directories, categories, arbitrary metadata and access rights.
+Agendafs is a FUSE-based filesystem for writing notes. It creates a shim over [vdir storages](https://pimutils.org/specs/vdir/), allowing you to write notes as regular files and synchronize them back to a caldav server. It supports directories, categories, arbitrary metadata and access rights.
## Status
Agendafs is still in early development and is alpha-level software. It
-probably leaks memory, destroys files and might summon demons. However,
-I use it daily for my note-taking mostly without issues. If you try it out, I recommend creating a new calendar specifically for agendafs and also
+probably leaks memory, destroys files and might summon demons. However, I
+use it daily for my note-taking mostly without issues. If you try it out,
+I recommend creating a new calendar specifically for agendafs and also
regularly backing up your notes elsewhere.
## Installation
@@ -46,7 +47,7 @@ can also be accessed via xattr(7). Currently supported attributes are:
- `user.categories` - comma separated list of categories
- `user.class` - Can be either private, public, confidential.
-You can also store arbitrary data.
+You can also store arbitrary metadata under other user attributes.
Agendafs pairs well with file explorers like `ranger`, `lf` or `nnn`.
@@ -68,7 +69,7 @@ Some major features are missing before 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)
-Depending on the calendar you use, there might be limitations as to how big
+Depending on the caldav server, there might be limitations as to how big
a file can be. Usually the limit of one entry is ~5MB, but agendafs does
currently not enforce any file limit.