Tools for package example

Badge

Use one of the snippets below to add a link to godocs.io from your project website or README file:

HTML

<a href="https://godocs.io/git.sr.ht/~sircmpwn/go-bare/example"><img src="https://godocs.io/git.sr.ht/~sircmpwn/go-bare/example?status.svg" alt="Go Documentation"></a>

Markdown

[![Go Documentation](https://godocs.io/git.sr.ht/~sircmpwn/go-bare/example?status.svg)](https://godocs.io/git.sr.ht/~sircmpwn/go-bare/example)

The example package does not have a package declaration comment. See the Go documentation guidelines for information on how to write a package comment. It's important to write a good summary of the package in the first sentence of the package comment. godocs.io indexes the first sentence and displays it in search results.