agendafs

A filesystem for your calendar.

commit b52c9e57068b0c124bd693e716cbcf1940da53b6
parent a4e953198d96ec93bea5109ad2e0794ea7802f8f
Author: Marc Coquand <marc@coquand.email>
Date:   Mon,  2 Jun 2025 12:07:04 +0100

README

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

1 file changed, 24 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
@@ -30,15 +30,10 @@ $ # when done vdirsyncer can sync it back to your caldav server
 $ vdirsyncer sync
 ```
 
-## Status
-
-POC stage, still very early alpha.
-
 ## Motivation
 
 Caldav is great in the sense that it has a lot of support from various
-app. However, the format is not particularly human-friendly. In the iCalendar
-spec, VJOURNAL entries look like this:
+app. However, the format is not particularly human-friendly. For example, VJOURNAL entries look like this:
 
 ```
   BEGIN:VJOURNAL
@@ -59,6 +54,28 @@ spec, VJOURNAL entries look like this:
 
 These are not really intended to be edited by users.
 
+## Status
+
+Early alpha. Very WIP.
+
+### Planned features
+
+- [ ] VJOURNAL - Now the first true journaling filesystem!
+	- [x] Create
+	- [x] Delete locally
+	- [ ] Delete remote
+	- [x] Read
+	- [x] Rename
+	- [x] Write
+	- [ ] Set creation dates - not mandatory but supresses a few warnings
+	- [ ] Directory structure
+- [ ] VTODO
+- [ ] Categories (Maybe via symlinks?)
+- [ ] VEVENTS
+- [ ] Relationships / linking
+- [ ] VALARM
+- [ ] VFREEBUSY
+
 ## Dependencies
 
 Some C compiler along with libfuse and pkg-config.
@@ -68,17 +85,12 @@ like [vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/when.html#).
 
 ## Building
 
-Run
-
 ```
-make
+$ make
 ```
 
 ## Using
 
-Note: This is still in early alpha. It will change, break and more. Don't
-use it for any critical data.
-
 1. Set up a new calendar with VJOURNAL support. See below for how its done in Nextcloud.
 
 2. Set up [vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/installation.html).
@@ -141,23 +153,6 @@ Longer text
 The `---` are mandatory.
 
 
-## Planned features
-- [ ] VJOURNAL - Now the first true journaling filesystem!
-	- [x] Create
-	- [x] Delete locally
-	- [ ] Delete remote
-	- [x] Read
-	- [x] Rename
-	- [x] Write
-	- [ ] Set creation dates - not mandatory but supresses a few warnings
-	- [ ] Directory structure
-- [ ] VTODO
-- [ ] Categories (Maybe via symlinks?)
-- [ ] VEVENTS
-- [ ] Relationships / linking
-- [ ] VALARM
-- [ ] VFREEBUSY
-
 
 ## Why C?