From 908329bf76f9881db8e92da4d3a76a800501c3f9 Mon Sep 17 00:00:00 2001 From: Justin Ricks Date: Sun, 17 Dec 2023 21:07:49 -0700 Subject: [PATCH] doc: update readme --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9994f46..bd1eaf8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# retryhttp +# retryhttp [![Build Status](https://github.com/justinrixx/retryhttp/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/justinrixx/retryhttp/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/justinrixx/retryhttp.svg)](https://pkg.go.dev/github.com/justinrixx/retryhttp) `retryhttp` allows you to add HTTP retries to your service or application with no refactoring at all, just a few lines of configuration where your client is instantiated. This package's goals are: @@ -6,7 +6,7 @@ - [Provide a good starting point for retry behavior](./docs/default.md) - [Make customizing retry behavior easy](./docs/options.md) - [Allow for one-off behavior changes without needing multiple HTTP clients](./docs/options.md#example) -- 100% Go, with no external dependencies (have a peek at `go.mod`) +- 100% standard library, with no external dependencies (have a peek at `go.mod`) ## How it works @@ -14,6 +14,12 @@ `http.RoundTripper`s are also highly composable. By default, this package uses `http.DefaultTransport` as its underlying `RoundTripper`, but you may choose to wrap a customized one that sets `MaxIdleConns`, or even [something like this](https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp#Transport) that captures metric spans to instrument your calls. +## Get it + +```bash +$ go get github.com/justinrixx/retryhttp +``` + ## Example ```go