From 7cd7677e9b0cc2539b11e48fc4badcaaeeccd23b Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Thu, 26 Nov 2020 04:06:33 +0000 Subject: [PATCH] docs(readme): add badges, Go ref, and lincense links --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 15e1b2a..d543f1e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,36 @@ -# undent +

+ undent +

+

+ + Go package which removes leading indentation/white-space from multi-line + strings and byte slices. + +

-Go package which removes leading indentation/white-space from multi-line strings -and byte slices. +

+ + Go Reference + + + Actions Status + + + Coverage + + + + + + GitHub pull requests + + + License Status + +

```go s := undent.String(` @@ -18,3 +46,12 @@ fmt.Println(s) "hello": "world" } ``` + +## Documentation + +Please see the [Go Reference](https://pkg.go.dev/github.com/jimeh/undent) for +documentation and examples. + +## License + +[MIT](https://github.com/jimeh/undent/blob/master/LICENSE)