README

favro_sync/__init__.py

@@ -29,7 +29,6 @@ Features:
 
 Limitations:
 
-- Only cards in todolist is fetched at the moment.
 - Tasks (checklists on cards) cannot be updated or changed.
 - Images cannot be updated or changed.
 - You cannot create new cards, nor any other files.
@@ -43,7 +42,35 @@ Limitations:
    [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole
    bunch automatically.)
 
-Use `umount` to unmount the cards again.
+Use `umount` to unmount the mounted directory again.
+
+### Directory structure and latency
+
+Directory structure is something like:
+
+```
+mount
+ -> Collection A
+     -> CARD-101
+     -> CARD-111
+     -> ...
+ -> Collection B
+     -> CARD-201
+     -> CARD-221
+     -> ...
+ -> ...
+```
+
+Some programs like Obsidian eagerly load and cache unneeded files in memory,
+which can reduce performance when those files are fetched over a network. You
+can limit this by configuring favro-sync to only expose individual collections
+by adding a `FAVRO_COLLECTION_FILTER` secret containing allowed collection
+names, like so:
+
+```
+Collection A
+Collection B
+```
 
 ## Architecture
 
@@ -64,12 +91,12 @@ Following features are work in progress:
     3. Remove all TaskList's except for the latest (how to determine latest?)
     4. That's three requests just to save a freaking list of tasks!
 - [ ] Frontmatter: Writable Dependencies.
-- [ ] Usability: Richer directory structure
 - [ ] Usability: Allow users to toggle Obsidian mode, instead of being default.
 - [ ] Precision: Get the correct last-modified date.
 - [ ] Performance: Improve cache behaviour. User and tags can have much longer cache times.
 - [ ] Performance: Parallelize requests.
     * Paginated pages can be easily parallelize.
+- [X] Usability: Richer directory structure
 - [X] Frontmatter: Arbitrary structured data (Custom Fields)? Read-only.
 - [X] Frontmatter: Readable Dependencies. As vault links in Obsidian mode.
 """