an HTTP server that works with Github hooks.
Goreadme is a tool for creating README.md files from Go doc of a given package. This project is the Github app on top of this tool. It fully automates the process of keeping the README.md file updated.
-
Press the "Configure" button.
-
Choose your account, or an organization that owns the repository.
-
Review the permissions and provide access to goreadme to repositories.
-
Click Save.
You should see PRs from goreadme bot in your github repos. For more features, or to trigger goreadme on demand, use the Goreadme website.
Once integrated with a repository, goreadme is registered on a Github hook, that calls goreadme server whenever the repository default branch is modified. Goreadme then computes the new README.md 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.
Adding a goreadme.json file to your repository main directory can enable some
customization to the generated readme file. The configuration is available
according to goreadme.Config struct.
Created by goreadme