lawn

README

lawn

GitHub Contributions Graph scraper.

Features

• Provide svg image of your GitHub Contributions Graph.
• Support Google Cloud Run and other container services.

Usage as library

go get github.com/ww24/lawn

Configurations

• Set your GitHub Username as GITHUB_USERNAME.

Use by Firebase Hosting

• https://firebase.google.com/docs/hosting/manage-cache
• https://firebase.google.com/docs/hosting/cloud-run

Documentation

Index

• type Client
  • func NewClient() *Client
  • func (c *Client) Fetch(ctx context.Context, w io.Writer, username string) error

Types

type Client

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

Client represents GitHub contributions graph scraper client.

func NewClient

func NewClient() *Client

NewClient returns a new client.

func (*Client) Fetch

func (c *Client) Fetch(ctx context.Context, w io.Writer, username string) error

Fetch fetches github contributions graph svg.