From 7c58998dea6d9ff6ba79afa8aeb1ed51ce267b77 Mon Sep 17 00:00:00 2001 From: Tor E Hagemann Date: Sat, 25 Jun 2022 16:40:29 -0700 Subject: [PATCH 1/2] docs: add TOC to README.md plus Install section --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index bad440f3..875ccc5c 100644 --- a/README.md +++ b/README.md @@ -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 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 @@ -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. From 950ab0eb2263998e0328feb113801a1a83024ddc Mon Sep 17 00:00:00 2001 From: Tor E Hagemann Date: Sat, 25 Jun 2022 17:00:21 -0700 Subject: [PATCH 2/2] docs: recommend some common package folders, too --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 875ccc5c..898befc8 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,13 @@ See the examples directory for more complete examples. ```sh # after: go mod init ... go get -u github.com/danielgtaylor/huma@latest -# now try: import "github.com/danielgtaylor/huma" + +# 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