Fork me on GitHub

Go ReadMe

Generate the start of your ReadMe.md file for your Go library (see the original blog post Creating a Better ReadMe for GoLang Packages). Once you've done this, copy to clipboard, paste into your ReadMe and change as you see fit. This is only a suggestion and helps you to not forget some little things. Please help improve this by sending me a PR. Feel free to follow me @andychilton or my blog at chilts.org.

All Steps

Step {{ step }}






The name that will be imported (usually the name of your project/repo).


A short one-line summary, around 5-9 words.

Depending on your answer, we'll ask different questions.


The <username> part of github.com/{{ username || '<username>' }}/{{ name || '<name>' }}.


The <username> part of bitbucket.org/{{ username || '<username>' }}/{{ name || '<name>' }}.

Is this correct (please fill in project name and username first)?

go get {{ where === 'github' ? 'github.com' : 'bitbucket.org' }}/{{ username || '<username>' }}/{{ name || '<name>' }}
go get

Please provide your own go get instructions.

Add other skeleton headings:

Would you like to include badges for the following?

(If you want any more badge options, send me a Pull Request to the Repo. Thanks.)

What license is this package?

(If you want any more license options, send me a Pull Request to the Repo. Thanks.)

ReadMe

{{ markdown }}

Preview (0.5s debounce)