From 953daff64241cc30f26c8fc676454e0110c74736 Mon Sep 17 00:00:00 2001
From: takunomi-build-bot <build-bot@takunomi.space>
Date: Fri, 27 Sep 2024 00:01:32 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?=
 =?UTF-8?q?to=20latest=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
---
 README.md | 27 +++++++++++++++++++++++++--
 setup.py  | 15 ++++++++++++---
 2 files changed, 37 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index c88628d..0358350 100644
--- a/README.md
+++ b/README.md
@@ -17,16 +17,39 @@ Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library.
 
 Limitations:
 
-- Only works for TODO files.
+- Only cards in todolist is fetched at the moment.
 - Doesn't include title anywhere.
 - Tasks cannot be updated or changed.
+- Slow, due to inefficient use of caches.
 
 A more complete implementation will probably require a Markdown parser, to
 parse the saved input, and distribute it across the various Card fields (card
 name, description, tasks, etc...)
 
+## Usage
 
-# License
+1. Install dependencies `pip install -r requirements.txt`
+2. Setup [secrets](https://gitfub.space/Jmaa/secret_loader]): `FAVRO_ORGANIZATION_ID`, `FAVRO_USERNAME`, `FAVRO_PASSWORD`.
+3. Run `python -m favro_sync <MOUNT_DIR>`. Use the `--help` argument to get an
+   overview of all supported flags (there is a lot, because
+   [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole
+   bunch automatically.)
+
+
+## Dependencies
+
+All requirements can be installed easily using:
+
+```bash
+pip install -r requirements.txt
+```
+
+Full list of requirements:
+- [requests](https://pypi.org/project/requests/)
+- [secret_loader](https://gitfub.space/Jmaa/secret_loader)
+
+
+## License
 
 ```
 MIT License
diff --git a/setup.py b/setup.py
index 0e59457..432afa6 100644
--- a/setup.py
+++ b/setup.py
@@ -24,13 +24,23 @@ Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library.
 
 Limitations:
 
-- Only works for TODO files.
+- Only cards in todolist is fetched at the moment.
 - Doesn't include title anywhere.
 - Tasks cannot be updated or changed.
+- Slow, due to inefficient use of caches.
 
 A more complete implementation will probably require a Markdown parser, to
 parse the saved input, and distribute it across the various Card fields (card
 name, description, tasks, etc...)
+
+## Usage
+
+1. Install dependencies `pip install -r requirements.txt`
+2. Setup [secrets](https://gitfub.space/Jmaa/secret_loader]): `FAVRO_ORGANIZATION_ID`, `FAVRO_USERNAME`, `FAVRO_PASSWORD`.
+3. Run `python -m favro_sync <MOUNT_DIR>`. Use the `--help` argument to get an
+   overview of all supported flags (there is a lot, because
+   [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole
+   bunch automatically.)
 """.strip()
 
 PACKAGE_DESCRIPTION_SHORT = """
@@ -53,8 +63,7 @@ REQUIREMENTS_MAIN = [
     'requests',
     'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader',
 ]
-REQUIREMENTS_TEST = [
-]
+REQUIREMENTS_TEST = []
 
 
 setup(