Skip to content

Commit fd544db

Browse files
committed
update README
1 parent 10f5878 commit fd544db

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
# CalendarAPI
1+
# 📆 CalendarAPI
22

33
CalendarAPI is a service that parses iCal files and exposes their content via gRPC or a REST API. It uses Viper for configuration, which supports runtime reloads.
44

5-
## Features
5+
## ⚙️ Features
66

7-
- Parse iCal files from URLs or local files
8-
- Expose calendar events via gRPC or REST API
9-
- Dynamic configuration reloads
10-
- Event filtering and relabeling rules
7+
- ✅ Parse iCal (.ics) files from **URLs or local files**
8+
- ✅ Exposes events via **REST** and **gRPC** APIs
9+
- ✅ Built-in **rule engine** for relabeling, filtering, and skipping events
10+
- ✅ Supports **hot configuration reloads** (with [Viper](https://github.com/spf13/viper))
11+
-[HomeAssistant Add-On] to easily host CalendarAPI on your Home Assistant
1112

1213
## Configuration
1314

@@ -139,3 +140,5 @@ Contributions are welcome! Please open an issue or submit a pull request.
139140
## License
140141

141142
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
143+
144+
[HomeAssistant Add-On]: https://github.com/SpechtLabs/homeassistant-addons/tree/main/calendar_api

0 commit comments

Comments
 (0)