Skip to content

Commit

Permalink
docs: add more info about the package
Browse files Browse the repository at this point in the history
  • Loading branch information
faabiosr committed Sep 5, 2024
1 parent 1ee471f commit aff82c3
Showing 1 changed file with 13 additions and 22 deletions.
35 changes: 13 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,18 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/faabiosr/echo-middleware?style=flat-square)](https://goreportcard.com/report/github.com/faabiosr/echo-middleware)
[![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/faabiosr/echo-middleware/blob/master/LICENSE)

## Description
## :tada: Overview
echo-middleware is a Go package that provides multiple middlewares for Echo Framework.

## Requirements
echo-middleware requires Go 1.19 or later and Echo Framework v4.
## :relaxed: Motivation
After writing these middlewares several times, it was decided to create a package with useful middlewares for echo.

## Installation
## :dart: Installation

### Requirements
echo-middleware requires Go 1.21 or later and Echo Framework v4.

### How to use
Use go get.
```sh
$ go get github.com/faabiosr/echo-middleware
Expand All @@ -23,28 +28,14 @@ Then import the package into your own code:
import "github.com/faabiosr/echo-middleware"
```

## Development
## :toolbox: Development

### Requirements
- Install [Go](https://golang.org)
- Install [GolangCI-Lint](https://github.com/golangci/golangci-lint#install)

### Makefile
```sh
# Clean up
$ make clean

# Download project dependencies
$ make configure

# Run tests and generates html coverage file
$ make cover

# Format all go files
$ make fmt

# Run tests
$make test
```
Please run `make help` to see all the available targets.

## License
## :page_with_curl: License
This project is released under the MIT licence. See [LICENSE](https://github.com/faabiosr/echo-middleware/blob/master/LICENSE) for more details.

0 comments on commit aff82c3

Please sign in to comment.