Skip to content

Commit 4b2d93e

Browse files
committed
docs(readme): update project status and running instructions
1 parent c5aa961 commit 4b2d93e

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,55 @@ In the future, the project is planned to grow toward:
1818

1919
## Current Status
2020

21-
This project is in a very early stage of development.
21+
This project is still in an early stage of development.
2222

2323
What exists today:
2424

2525
- configuration loading and validation
2626
- typed check configuration models
27-
- basic application/checker scaffolding
28-
- an initial HTTP checker implementation
27+
- periodic check execution with retries and jitter
28+
- HTTP checks
29+
- TCP checks
30+
- DNS checks
31+
- TLS certificate checks
32+
- gRPC health checks via `grpc.health.v1.Health/Check`
2933

3034
What does not exist yet in a finished form:
3135

32-
- stable runtime behavior
3336
- persistent state storage
3437
- finalized status aggregation rules
3538
- public/internal status page generation
39+
- production-ready logging and observability
3640
- stable external interfaces
3741

42+
## Running
43+
44+
The application expects configuration to be provided through `CONFIG_DIR`.
45+
46+
Expected layout:
47+
48+
- `services.yaml`
49+
- `checks/*.yaml`
50+
51+
Example configuration files are available in:
52+
53+
- `examples/services.yaml`
54+
- `examples/checks/api-checks.yaml`
55+
56+
Run with:
57+
58+
```bash
59+
CONFIG_DIR=./examples go run ./cmd/pulse
60+
```
61+
62+
## Notes
63+
64+
A few implementation details are intentionally narrow at this stage:
65+
66+
- gRPC support currently targets only the standard health check API: `grpc.health.v1.Health/Check`
67+
- result writing is still backed by a temporary fake writer
68+
- internal architecture is still evolving
69+
3870
## Important
3971

4072
Everything may change.

0 commit comments

Comments
 (0)