这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: add TOC to README.md plus Install section #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 29, 2022
Merged

docs: add TOC to README.md plus Install section #54

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c58998
docs: add TOC to README.md plus Install section
hagemt Jun 25, 2022
950ab0e
docs: recommend some common package folders, too
hagemt Jun 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
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,20 @@ 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

# and to taste:
go get -u github.com/danielgtaylor/huma/cli
go get -u github.com/danielgtaylor/huma/humatest
go get -u github.com/danielgtaylor/huma/middleware
go get -u github.com/danielgtaylor/huma/responses
# for example
```

# 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