github.com/posener/goreadme-server
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
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.
