Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rhnvrm committed Jun 22, 2021
1 parent 0986ce1 commit 0d2f4c3
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# fastglue

Fastglue is a "glue" wrapper over [fasthttp](https://github.com/valyala/fasthttp) and [fasthttprouter](https://github.com/fasthttp/router).

Currently, fastglue is successfully used at [Zerodha](https://zerodha.com) in production serving millions of requests per second.
## Overview [![Go Reference](https://pkg.go.dev/badge/github.com/zerodha/fastglue.svg)](https://pkg.go.dev/github.com/zerodha/fastglue) [![Zerodha Tech](https://zerodha.tech/static/images/github-badge.svg)](https://zerodha.tech)

fastglue is an opinionated, bare bones wrapper that glues together [fasthttp](https://github.com/valyala/fasthttp)
and [fasthttprouter](https://github.com/fasthttp/router) to act as a micro HTTP framework. It helps eliminate
boilerplate that would otherwise be required when using these two libraries to
write HTTP servers. It enables:

- Performance benefits of fasthttp + fasthttprouter.
- Pre/post middleware hooks on HTTP handlers.
- Simple middlewares for validating (existence, length range) of params in HTTP
requests.
- Functions for unmarshalling request payloads (Form encoding, JSON, XML) into
arbitrary structs.
- Shortcut functions for registering handlers, `GET()`, `POST()` etc.
- Shortcut for fasthttp listening on TCP and Unix sockets.
- Shortcut for graceful shutdown hook on the fasthttp server.
- Opinionated JSON API response and error structures.
- Shortcut functions for sending strings, bytes, JSON in the envelope structure
without serialization or allocation.

## Install

Expand Down

0 comments on commit 0d2f4c3

Please sign in to comment.