posener/goreadme-server

Github App for goreadme package

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.

Usage

1. Go to https://github.com/apps/goreadme.

2. Press the "Configure" button.

3. Choose your account, or an organization that owns the repository.

4. Review the permissions and provide access to goreadme to repositories.

5. 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.

How does it Work

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.

Customization

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

goreadme-server's Issues

Bad URL for goreadme link

Hey!

Just a heads up, the link for the goreadme GitHub repo is not correct in the following text of the home page:

Goreadme service uses goreadme - is a tool created by the service author, for generating README.md files from Go doc of a given package.

Add google analytics

Does not work for github projects with vanity imports

When I add the project: 'github.com/bramp/goredirects'

I get the following error when processing:
'Failed running goreadme: failed getting github.com/bramp/goredirects: not at canonical import path'

This seems related to the fact this project uses a vanity import URL of 'bramp.net/goredirects'

Add stars to projects and sort by star for open source projects