readme

Documentation

Index

• type Synchronizer
  • func New(logger *logrus.Logger) *Synchronizer
  • func (s *Synchronizer) Sync(packageDir string) error

Types

type Synchronizer

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

Synchronizer handles the process of generating a README.md from a template and documentation source.

func New

func New(logger *logrus.Logger) *Synchronizer

New creates a new Synchronizer instance.

func (*Synchronizer) Sync

func (s *Synchronizer) Sync(packageDir string) error

Sync performs the README synchronization for a given package directory.