readme

Documentation

Index

• type Readme
  • func New(name, source string) *Readme
  • func (r *Readme) EnableInstallable()
  • func (r *Readme) ReleaseURL() string
  • func (r *Readme) WriteFile() error

Types

type Readme

type Readme struct {
	Name        string
	Source      string
	Installable bool
}

Readme is a struct representation of a readme template

func New

func New(name, source string) *Readme

New takes a name and returns a viable readme struct

func (*Readme) EnableInstallable

func (r *Readme) EnableInstallable()

EnableInstallable enables the installable details of the readme to be turned on.

func (*Readme) ReleaseURL

func (r *Readme) ReleaseURL() string

ReleaseURL returns a string URL of the releases location if there is known to be one.

func (*Readme) WriteFile

func (r *Readme) WriteFile() error

WriteFile writes the current readme file struct to an actualized README file. It returns any errors it encounters with the template and writing the file to disk.