jimeh/undent
1
0
Fork 0
mirror of https://github.com/jimeh/undent.git synced 2026-02-19 11:56:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2 from jimeh/update-readme

Browse Source 
docs(readme): add badges, Go ref, and lincense links
This commit is contained in:
Jim Myhrberg
2020-11-26 04:13:58 +00:00
committed by GitHub
parent 4dfb369149 7cd7677e9b
commit ffa6b79166
1 changed files with 40 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -1,8 +1,36 @@
# undent
<h1 align="center">
undent
</h1>
<p align="center">
<strong>
Go package which removes leading indentation/white-space from multi-line
strings and byte slices.
</strong>
</p>
Go package which removes leading indentation/white-space from multi-line strings
and byte slices.
<p align="center">
<a href="https://pkg.go.dev/github.com/jimeh/undent">
<img src="https://img.shields.io/badge/%E2%80%8B-reference-387b97.svg?logo=go&logoColor=white"
alt="Go Reference">
</a>
<a href="https://github.com/jimeh/undent/actions">
<img src="https://img.shields.io/github/workflow/status/jimeh/undent/CI.svg?logo=github" alt="Actions Status">
</a>
<a href="https://codeclimate.com/github/jimeh/undent">
<img src="https://img.shields.io/codeclimate/coverage/jimeh/undent.svg?logo=code%20climate" alt="Coverage">
</a>
<a href="https://github.com/jimeh/undent/issues">
<img src="https://img.shields.io/github/issues-raw/jimeh/undent.svg?style=flat&logo=github&logoColor=white"
alt="GitHub issues">
</a>
<a href="https://github.com/jimeh/undent/pulls">
<img src="https://img.shields.io/github/issues-pr-raw/jimeh/undent.svg?style=flat&logo=github&logoColor=white" alt="GitHub pull requests">
</a>
<a href="https://github.com/jimeh/undent/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/jimeh/undent.svg?style=flat" alt="License Status">
</a>
</p>
```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)