From 33f2b811de43c4f7991910d85e1aa46fe804f113 Mon Sep 17 00:00:00 2001
From: redxef <federanko.manuel@gmail.com>
Date: Wed, 7 Dec 2022 18:12:12 +0100
Subject: [PATCH] Update readme, fill-in package metadata.

---
 README.md    | 20 +++++++++++++++++++-
 setup.py     |  3 +++
 test/test.py |  1 -
 3 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 72943f8..b77cbaa 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,26 @@
 # Radicale SQL storage plugin
 
+A storage plugin for [Radicale](https://radicale.org) with some extra features.
+
+Can automatically generate birthday calendars based on address books.
+
+## Configuration
+
+Example
+
+```ini
+[storage]
+type=radicale_sql
+url=sqlite:///data.db
+generate_birthday_calendars=False
+```
+
 ## TODO
 
-- ensure all database operations run in one transaction
+- ~~ensure all database operations run in one transaction~~
 - implement caching
 - write unit tests
+- ~~write integration test~~
+- extend integration test to include auto-generated collections
 - run cleanup of `item_history` and `collection_state` tables
+- integrate alembic
diff --git a/setup.py b/setup.py
index 8de0d39..8538e13 100644
--- a/setup.py
+++ b/setup.py
@@ -5,5 +5,8 @@ from distutils.core import setup
 
 setup(
     name='radicale-sql',
+    version='0.1.0',
     packages=['radicale_sql'],
+    description='A SQL backed storage for radicale.',
+    url='https://gitea.redxef.at/redxef/radicale-sql',
 )
diff --git a/test/test.py b/test/test.py
index 3731a9b..9bd1508 100755
--- a/test/test.py
+++ b/test/test.py
@@ -74,7 +74,6 @@ def test_caldav():
 
         calendar0_updates = calendar0.objects_by_sync_token(calendar0_token)
         assert len(list(calendar0_updates)) == 1
-        #assert list(calendar0_updates)[0].is_deleted, list(calendar0_updates)[0]
         try:
             list(calendar0_updates)[0].load()
         except caldav.lib.error.NotFoundError: