update README: reference REPO_POLICIES.md, add License/Author sections, document new Makefile targets
Some checks failed
check / check (push) Failing after 39s
Some checks failed
check / check (push) Failing after 39s
This commit is contained in:
21
README.md
21
README.md
@@ -327,10 +327,13 @@ tracks reachability:
|
||||
|
||||
```sh
|
||||
make build # Build binary to bin/dnswatcher
|
||||
make test # Run tests with race detector
|
||||
make test # Run tests with race detector and 30s timeout
|
||||
make lint # Run golangci-lint
|
||||
make fmt # Format code
|
||||
make check # Run all checks (format, lint, test, build)
|
||||
make fmt # Format code (writes)
|
||||
make fmt-check # Read-only format check
|
||||
make check # Run all checks (fmt-check, lint, test, build)
|
||||
make docker # Build Docker image
|
||||
make hooks # Install pre-commit hook
|
||||
make clean # Remove build artifacts
|
||||
```
|
||||
|
||||
@@ -385,7 +388,17 @@ docker run -d \
|
||||
|
||||
## Project Structure
|
||||
|
||||
Follows the conventions defined in `CONVENTIONS.md`, adapted from the
|
||||
Follows the conventions defined in `REPO_POLICIES.md`, adapted from the
|
||||
[upaas](https://git.eeqj.de/sneak/upaas) project template. Uses uber/fx
|
||||
for dependency injection, go-chi for HTTP routing, slog for logging, and
|
||||
Viper for configuration.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
MIT — see [LICENSE](LICENSE).
|
||||
|
||||
## Author
|
||||
|
||||
[@sneak](https://sneak.berlin)
|
||||
|
||||
Reference in New Issue
Block a user