go-github-readme

README

Example

An example program to get readme file for a repository using google/go-github.

Example Usage

To obtain README from a private repository accessible to installation,

go run example.go \
    -app-id <app-id> \
    -private-key private-key.pem \
    -repo {owner}/{repo}

Should return something like,

gh-integration-tests/go-githubapp-repo-one README:

# About This Repository

This repository is used for integration tests for [github.com/tprasadtp/go-githubapp].

[github.com/tprasadtp/go-githubapp]: https://github.com/tprasadtp/go-githubapp

Documentation

Overview

This is an example CLI which fetches README for a repository using app credentials and github.com/google/go-github/v61/github. This is meant as an example and is not covered by semver compatibility guarantees.