Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

Example README.md file for Go libraries

When users of our library land on our project page, we need to make sure we have the right things in our README.md so that they can find what they need to know quickly. This might be your license or links to GoDoc and/or your testing page.

Even though we have GoDoc for the programmer docs, it is not enough and is not necessarily aimed at the same audience as the users who land here. This is especially true for people new to Go.

See the original blog post for why this project exists : Creating a Better ReadMe for GoLang Packages.

Use the online GoReadMe generator.

Author

By Andrew Chilton, @twitter.

For AppsAttic, @AppsAttic.

LICENSE

WTFPL.

(Ends)

About

An example ReadMe file for Go libraries.

Topics

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.