Goreadme is a service that automatically creates and updates readme files for Go Github projects from the Go doc of the project.
You should see PRs from goreadme bot in your Github repositories.
Once integrated with a repository, goreadme is registered on a Github hooks, that calls goreadme server whenever the repository default branch is modified. Goreadme then computes the new readme file and compairs it to the exiting one. If a change is needed, Goreadme will create a PR with the new content of the README.md file. Genrating the readme file can also be triggered manually here.
Goreadme service uses goreadme - is a tool created by the service author, for generating README.md files from Go doc of a given package.
goreadme.json file to your repository main directory can enable some
customization to the generated readme file. The configuration is available
In order to use goreadme with your Github repositories, login is required.