https://github.com/posener/goreadme-server

Github App for goreadme package
https://github.com/posener/goreadme-server

github-app go godoc golang markdown readme

Last synced: 28 days ago
JSON representation

Github App for goreadme package

• Host: GitHub
• URL: https://github.com/posener/goreadme-server
• Owner: posener
• License: mit
• Created: 2019-03-06T18:18:19.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-02T21:35:21.000Z (about 5 years ago)
• Last Synced: 2024-10-05T12:42:05.184Z (3 months ago)
• Topics: github-app, go, godoc, golang, markdown, readme
• Language: Go
• Homepage: https://goreadme.herokuapp.com/
• Size: 124 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# goreadme-server

[![GoDoc](https://godoc.org/github.com/posener/goreadme-server?status.svg)](http://godoc.org/github.com/posener/goreadme-server)

[![goreadme](https://goreadme.herokuapp.com/badge/posener/goreadme-server.svg)](https://goreadme.herokuapp.com)

an HTTP server that works with Github hooks.

[Goreadme](https://github.com/posener/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](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](https://goreadme.herokuapp.com).

#### 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](https://godoc.org/github.com/posener/goreadme#Config).

---

Created by [goreadme](https://github.com/apps/goreadme)