nikdoof/rustical
1
1
Fork 0
mirror of https://github.com/lennart-k/rustical.git synced 2025-12-13 22:52:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme since we a slowly approaching a usable state

Browse Source
This commit is contained in:
Lennart
2025-04-26 14:59:47 +02:00
parent 17c245901d
commit d3710afe7b
2 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -2,17 +2,18 @@
a CalDAV/CardDAV server a CalDAV/CardDAV server
> [!CAUTION] > [!WARNING]
> RustiCal is **not production-ready!** > RustiCal is **not production-ready!**
> There can be changes to the database without migrations and there's no guarantee that all endpoints are secured yet. > I'm just starting to use it myself so I cannot guarantee that everything will be working smoothly just yet.
> If you still want to play around with it in its current state, absolutely feel free to do so but know that not even I use it productively yet. > I hope there won't be any manual migrations anymore but if you want to be an early adopter some SQL knowledge might be useful just in case.
> If you still want to play around with it in its current state, absolutely feel free to do so and to open up an issue if something is not working. :)
## Features ## Features
- easy to backup, everything saved in one SQLite database - easy to backup, everything saved in one SQLite database
- [WebDAV Push](https://github.com/bitfireAT/webdav-push/) support, so near-instant synchronisation to DAVx5 - [WebDAV Push](https://github.com/bitfireAT/webdav-push/) support, so near-instant synchronisation to DAVx5
- lightweight (the container image contains only one binary) - lightweight (the container image contains only one binary)
- adequately fast (I'd say blazingly fast™ :fire: if I did the benchmarks to back that claim up) - adequately fast (I'd love to say blazingly fast™ :fire: but I don't have any benchmarks)
- deleted calendars are recoverable - deleted calendars are recoverable
- Nextcloud login flow (In DAVx5 you can login through the Nextcloud flow and automatically generate an app token) - Nextcloud login flow (In DAVx5 you can login through the Nextcloud flow and automatically generate an app token)
- OpenID Connect support (with option to disable password login) - OpenID Connect support (with option to disable password login)

7
docs/index.md
View File

@@ -4,15 +4,16 @@ a CalDAV/CardDAV server
!!! warning !!! warning
RustiCal is **not production-ready!** RustiCal is **not production-ready!**
There can be changes to the database without migrations and there's no guarantee that all endpoints are secured yet. I'm just starting to use it myself so I cannot guarantee that everything will be working smoothly just yet.
If you still want to play around with it in its current state, absolutely feel free to do so but know that not even I use it productively yet. I hope there won't be any manual migrations anymore but if you want to be an early adopter some SQL knowledge might be useful just in case.
If you still want to play around with it in its current state, absolutely feel free to do so and to open up an issue if something is not working. :)
## Features ## Features
- easy to backup, everything saved in one SQLite database - easy to backup, everything saved in one SQLite database
- [WebDAV Push](https://github.com/bitfireAT/webdav-push/) support, so near-instant synchronisation to DAVx5 - [WebDAV Push](https://github.com/bitfireAT/webdav-push/) support, so near-instant synchronisation to DAVx5
- lightweight (the container image contains only one binary) - lightweight (the container image contains only one binary)
- adequately fast (I'd say blazingly fast™ :fire: if I did the benchmarks to back that claim up) - adequately fast (I'd love to say blazingly fast™ :fire: but I don't have any benchmarks)
- deleted calendars are recoverable - deleted calendars are recoverable
- Nextcloud login flow (In DAVx5 you can login through the Nextcloud flow and automatically generate an app token) - Nextcloud login flow (In DAVx5 you can login through the Nextcloud flow and automatically generate an app token)
- [OpenID Connect](setup/oidc.md) support (with option to disable password login) - [OpenID Connect](setup/oidc.md) support (with option to disable password login)