readme

package

v0.0.7 Latest Latest Go to latest Published: Apr 2, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

func New(path, startPlaceholder, endPlaceholder string) (Readme, error)

func (r *Readme) Content() (string, error)

func (r *Readme) Docs() (string, error)

func (r *Readme) EndPlaceholder() string

func (r *Readme) Path() string

func (r *Readme) StartPlaceholder() string

func (r *Readme) Validate(schemaPath string, layout string) error

func (r *Readme) WriteDocs(docs string) error