Skip to content

Commit c8d9ed9

Browse files
committed
Add README
Signed-off-by: Bryan Frimin <bryan@getprobo.com>
1 parent 0574235 commit c8d9ed9

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Kit
2+
3+
[![Go Reference](https://pkg.go.dev/badge/go.gearno.de/kit.svg)](https://pkg.go.dev/go.gearno.de/kit)
4+
[![Go Report Card](https://goreportcard.com/badge/go.gearno.de/kit)](https://goreportcard.com/report/go.gearno.de/kit)
5+
[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
6+
7+
Opinionated building blocks for production Go applications.
8+
9+
## About
10+
11+
Kit provides foundational packages for building production-grade Go services with sane defaults. It integrates observability primitives (OpenTelemetry tracing, Prometheus metrics, structured logging) as first-class concerns.
12+
13+
## Packages
14+
15+
| Package | Description |
16+
|---------|-------------|
17+
| `unit` | Application lifecycle, configuration, signal handling, and graceful shutdown |
18+
| `log` | Structured logging with `slog`, trace correlation, and multiple output formats |
19+
| `pg` | PostgreSQL client with connection pooling, tracing, and metrics |
20+
| `migrator` | Database schema migrations with advisory locking |
21+
| `httpserver` | HTTP server with request tracing and metrics |
22+
| `httpclient` | HTTP client with telemetry and connection management |
23+
| `worker` | Generic worker pool with backpressure |
24+
25+
## Requirements
26+
27+
- Go 1.25+
28+
29+
## Installation
30+
31+
```bash
32+
go get go.gearno.de/kit
33+
```
34+
35+
## Documentation
36+
37+
See the [Go package documentation](https://pkg.go.dev/go.gearno.de/kit) for API reference and examples.
38+
39+
## Contributing
40+
41+
Contributions are welcome. Please open an issue to discuss proposed changes before submitting a pull request.
42+
43+
## License
44+
45+
Kit is released under the [ISC License](LICENCE.txt).
46+
47+
## Author
48+
49+
Bryan Frimin

0 commit comments

Comments
 (0)