agendafs

A filesystem for your calendar.

commit 83e13619e64356767013ba800d4bb9ff7c0d8406
parent 537a7af1466378f9af551b7fc0c08f023c57eda2
Author: Marc Coquand <marc@coquand.email>
Date:   Wed, 23 Jul 2025 19:39:23 +0200

README

Diffstat:
M
README.md
 | 
24
+++++++++++-------------

1 file changed, 11 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -1,22 +1,20 @@
 # agendafs
 
-[Todo](todo.sr.ht/~marcc/agendafs)
+[Todo](https://todo.sr.ht/~marcc/agendafs)
 | [Mailing List](https://lists.sr.ht/~marcc/agendafs)
 
-Agendafs is a FUSE-based filesystem for writing notes that syncs to caldav
-servers through using [vdirsyncer](https://vdirsyncer.pimutils.org/) or
-similar tools. It supports directories, categories and access rights.
+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 synchronise them back to a caldav server. It supports directories, categories 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.
+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 issue.
 
 ## Installation
 
 Prerequisites: C compiler, libfuse, libuuid, libical and pkg-config
 
-You also need a tool that syncs `.ics` files with a caldav server, like
-[vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/when.html#).
+You also need to setup a tool that syncs vdir storages to a caldav server, like
+[vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/when.html#) or [pimsync](https://sr.ht/~whynothugo/pimsync/).
 
 To build:
 
@@ -28,9 +26,9 @@ make
 
 ## Basic principles
 
-Agendafs uses [vdirsyncer](https://vdirsyncer.pimutils.org/) as a backend to sync VJOURNAL entries to a remote caldav server.
+Agendafs uses [vdir storages](https://pimutils.org/specs/vdir/) as a backend to allow users to sync VJOURNAL entries to a remote caldav server.
 
-Each VJOURNAL vdir entry is represented as a file or directory in Agendafs. Edit these files like you would on a regular filesystem. iCalendar entries that have a parent relationship are represented as directories. iCalendar attributes can also be accessed via xattr(7). Currently supported attributes are:
+Each VJOURNAL vdir entry is represented as a file or directory in Agendafs. Edit these files like you would on a regular filesystem. VJOURNAL entries that have a parent relationship are represented as directories. Some VJOURNAL attributes 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.
@@ -51,17 +49,17 @@ Notably:
 
 - [Attachment support is missing](https://todo.sr.ht/~marcc/agendafs/2)
 - [Symlink support is missing](https://todo.sr.ht/~marcc/agendafs/11)
-- [File extensions are missing](https://todo.sr.ht/~marcc/agendafs/5)
+- [File extension support is missing](https://todo.sr.ht/~marcc/agendafs/5)
 
 ## Motivation
 
-I like plaintext notes, but found it hard to sync them and use them on mobile. The beauty of caldav is that you most likely have one if you're signed up an email provider, so you can take advantage of it and use it for sync.
+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.
 
-Caldav 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.
+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.
 
 ## Appendix
 
-### VJOURNAL support in Caldav
+### 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.