github

README

Github Readme

This library is used to get GitHub readme content in HTML as well as in JSON format

How to use it

	src := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: "<!-- Your github access token -->"},
	)
	ctx := context.Background()
	httpClient := oauth2.NewClient(ctx, src)
	githubClient := github.NewGithub(httpClient)

	content, err := githubClient.GetReadme(ctx, "<!-- organization name -->", "<!-- Github repository name -->")

	fmt.Println(content)
	fmt.Println(err)

Documentation

Index

• type Github
  • func NewGithub(client *http.Client) *Github
  • func (g *Github) GetReadme(ctx context.Context, owner string, repo string) (string, error)

Types

type Github

type Github struct {
	// contains filtered or unexported fields
}

func NewGithub

func NewGithub(client *http.Client) *Github

NewGithub initialized Github

func (*Github) GetReadme

func (g *Github) GetReadme(ctx context.Context, owner string, repo string) (string, error)

GetReadme returns readme content in HTML as well as in JSON format