Skip to content

Commit 7b48c32

Browse files
authored
chore: update README.md
1 parent 5f983a5 commit 7b48c32

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

Diff for: README.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
1010

1111
---
1212

13-
## Features
13+
## Features
1414

1515
1. **Actix Web**
1616
- Route handling (e.g., `GET`, `POST`)
@@ -62,17 +62,20 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
6262
```
6363

6464

65-
### API Endpoints 📡:
66-
- GET /: example endpoint to check request id logic
67-
- GET /logs: Fetch logs from ClickHouse (optional query params for pagination).
68-
- GET /health: Basic health check.
69-
- GET /fail: Example endpoint that triggers an error or panic for demonstration.
65+
### API Endpoints 📡
7066

71-
### CLI Commands
67+
| Endpoint | Method | Description | Example |
68+
|--------------|----------|-------------------------------|-------------------------------------|
69+
| `/` | GET | Demo endpoint with request ID | `curl http://localhost:1337` |
70+
| `/health` | GET | More Text | `curl http://localhost:1337/health` |
71+
| `/logs` | GET | Get paginated logs | `curl "http://localhost:1337/logs?limit=5&offset=0"` |
72+
| `/fail` | GET | Trigger handle panic example | `curl http://localhost:1337/fail` |
73+
74+
### CLI Commands 🛠️
7275
- `cargo run migrate`: Run ClickHouse migrations.
7376
- `cargo run serve`: Run the web server.
7477

75-
### Configuration
78+
### Configuration 🛠️
7679
- `confik.toml`: Configuration file for the application.
7780
- `.env`: Environment variables for the application (optional).
7881

@@ -85,10 +88,10 @@ docker build -t klickhouse-example:latest .
8588
docker build -t klickhouse-example:arm64 -f aarch64.Dockerfile .
8689
```
8790

88-
## Contributing
91+
## Contributing 🤝
8992

9093
Feel free to open issues or PRs to improve this example — whether adding features or refining best practices. All suggestions are welcome!
9194

92-
## License
95+
## License 📄
9396

9497
This project is open-sourced under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)