types

Documentation

Index

• Constants
• type IRepo
• type Repositories
  • func (r Repositories) Categorize() map[string][]Repository
• type Repository
  • func (r Repository) Expand(c *github.Client) Repository
  • func (r Repository) RName() string
  • func (r Repository) ROwner() string

Constants

const (
	// DefaultFilename is the output file name
	DefaultFilename = "README.md"
)

Types

type IRepo

type IRepo interface {
	ROwner() string
	RName() string
	Expand(*github.Client) Repository
}

IRepo capture the basic operations on a repository

type Repositories

type Repositories []Repository

Repositories are parsed repos ready to feed the templates

func (Repositories) Categorize

func (r Repositories) Categorize() map[string][]Repository

Categorize sorts repositories by it's declared category

type Repository

type Repository struct {
	URL         string `csv:"url"`
	Category    string `csv:"category"`
	Owner       string
	Name        string
	Description string
	Stargazers  int
	UpdatedAt   github.Timestamp // TODO make this human: Last update was X days/weeks/months/years ago
}

Repository maps a repo information

func (Repository) Expand

func (r Repository) Expand(c *github.Client) Repository

Expand feeds the repository with information pulled from Github

func (Repository) RName

func (r Repository) RName() string

RName returns the Github repository name

func (Repository) ROwner

func (r Repository) ROwner() string

ROwner returns the Github repository owner's name