read my

readme.md

@@ -1,16 +1,38 @@
-# calendar filter
+# Calendar Filter
 
-.ics calendar filter.
+A backend service for filtering `.ics` calendar files.
 
-## usage
+## Usage
 
-`
-/filtered-ics?url=the damn link&regex=valid regex to filter out
-`
+1. Clone the repository:
 
-## how to run
+   ```bash
+   git clone https://git.ldlda.com/lda/cal_filter_be.git
+   ```
 
-```sh
-git clone this repo
-cargo run
-```
+2. Install dependencies:
+
+   ```bash
+   cargo build
+   ```
+
+3. Run the server:
+
+   ```bash
+   cargo run
+   ```
+
+## Features
+
+- Regex-based filtering for `.ics` files.
+- Support for include and exclude rules.
+- Written in Rust for performance and safety.
+
+## API Endpoints
+
+- `/filter`: Accepts `.ics` files and filtering rules.
+- `/status`: Returns the server status.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.