Skip to content

Commit

Permalink
docs: 📝 updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paologaleotti committed Apr 9, 2024
1 parent 7238d58 commit ce437de
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
[![Blaze lint and build](https://github.com/paologaleotti/blaze/actions/workflows/build.yml/badge.svg)](https://github.com/paologaleotti/blaze/actions/workflows/build.yml)
[![SonarCloud analysis](https://github.com/paologaleotti/blaze/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/paologaleotti/blaze/actions/workflows/sonarcloud.yml)


![logo](https://github.com/paologaleotti/blaze/assets/45665769/a0c691df-b76b-4a4a-ac44-c622dd458352)

Simple and minimal Go template for building fast and type-safe backend applications
Expand All @@ -14,14 +13,21 @@ Simple and minimal Go template for building fast and type-safe backend applicati
You can find the full documentation with examples [here](https://github.com/paologaleotti/blaze/wiki).

## Features

- Minimal and low overhead
- Production ready
- Simple and conventional structure
- Fully compatible with standard [net/http](https://pkg.go.dev/net/http)
- HTTP utilities and error handling
- Strict linting with [golangci-lint](https://golangci-lint.run/)
- Custom HTTP error handling
- Request payload validation
- Structured logging with [zerolog](https://github.com/rs/zerolog)

All described features are implemented in the `httpcore` and `util` package.

## Stack

- **chi**: HTTP router (std net/http compatible)
- **chi/middleware**: middleware and hooks
- **validator/v10**: request body struct validation
Expand Down

0 comments on commit ce437de

Please sign in to comment.