Skip to content

Commit

Permalink
docs: 📝 updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paologaleotti committed May 10, 2024
1 parent 7acc1cd commit 09c631b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 20 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,27 @@
# blaze

[![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
Simple and minimal Go template for building fast, simple and mantainable web services and backend applications.

> [!IMPORTANT]
> While blaze is already used and working flawlessly in production, it's still evolving and may have breaking changes in the future.
You can find the full documentation with examples [here](https://github.com/paologaleotti/blaze/wiki).
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
- Fully compatible and base on standard [net/http](https://pkg.go.dev/net/http)
- 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)
- Full AWS Lambda support (see [serverless](https://github.com/paologaleotti/blaze/tree/feature/serverless) branch)

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

## Stack

Expand Down
12 changes: 0 additions & 12 deletions TODO.md

This file was deleted.

0 comments on commit 09c631b

Please sign in to comment.