Skip to content

Commit

Permalink
docs: add TOC to README.md plus Install section
Browse files Browse the repository at this point in the history
  • Loading branch information
hagemt authored Jun 25, 2022
1 parent bc14792 commit 7c58998
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

[![HUMA Powered](https://img.shields.io/badge/Powered%20By-HUMA-f40273)](https://huma.rocks/) [![CI](https://github.com/danielgtaylor/huma/workflows/CI/badge.svg?branch=master)](https://github.com/danielgtaylor/huma/actions?query=workflow%3ACI+branch%3Amaster++) [![codecov](https://codecov.io/gh/danielgtaylor/huma/branch/master/graph/badge.svg)](https://codecov.io/gh/danielgtaylor/huma) [![Docs](https://godoc.org/github.com/danielgtaylor/huma?status.svg)](https://pkg.go.dev/github.com/danielgtaylor/huma?tab=doc) [![Go Report Card](https://goreportcard.com/badge/github.com/danielgtaylor/huma)](https://goreportcard.com/report/github.com/danielgtaylor/huma)

- [What is huma?](#intro)
- [Example](#example)
- [Install](#install)
- [Documentation](#documentation)
- [Design](#design)

<a name="intro"></a>
A modern, simple, fast & opinionated REST API framework for Go with batteries included. Pronounced IPA: [/'hjuːmɑ/](https://en.wiktionary.org/wiki/Wiktionary:International_Phonetic_Alphabet). The goals of this project are to provide:

- A modern REST API backend framework for Go developers
Expand Down Expand Up @@ -103,6 +110,14 @@ See the examples directory for more complete examples.
- [Timeout](./examples/timeout/timeout.go) (show third-party request timing out)
- [Test](./examples/test/service.go) (how to write a test)

# Install

```sh
# after: go mod init ...
go get -u github.com/danielgtaylor/huma@latest
# now try: import "github.com/danielgtaylor/huma"
```

# Documentation

Official Go package documentation can always be found at https://pkg.go.dev/github.com/danielgtaylor/huma. Below is an introduction to the various features available in Huma.
Expand Down

0 comments on commit 7c58998

Please sign in to comment.