goreadme

README

goreadme

import "github.com/WillAbides/godoc2md/goreadme"

• Overview
• Index

Overview

Index

• func CheckReadmes(basePath, readmeName string, excludeDirs []string) (bool, []string, error)
• func FindReadmes(basePath, readmeName string, excludeDirs []string) (map[string]string, error)
• func ReadmeMD(pkgName string, writer io.Writer) error
• func VerifyReadme(pkgName, readmePath string) (bool, error)
• func WriteReadme(pkgName, readmePath string) (err error)

Package files

goreadme.go

func CheckReadmes

func CheckReadmes(basePath, readmeName string, excludeDirs []string) (bool, []string, error)

CheckReadmes checks that the readmes in basePath are up to date the first return value is a boolean indicating whether all readmes are up to date (false if any are outdated) the second return is the list of outdated readmes found

func FindReadmes

func FindReadmes(basePath, readmeName string, excludeDirs []string) (map[string]string, error)

FindReadmes finds all goreadme generated README.md files in basePath and child directories

returns a map of filepath:package

func ReadmeMD

func ReadmeMD(pkgName string, writer io.Writer) error

ReadmeMD writes readme content for the given package to writer

func VerifyReadme

func VerifyReadme(pkgName, readmePath string) (bool, error)

VerifyReadme checks that the file at readmePath has the correct content for pkgName

func WriteReadme

func WriteReadme(pkgName, readmePath string) (err error)

WriteReadme writes a README.md for pkgname to the given path

Documentation

Index

• func CheckReadmes(basePath, readmeName string, excludeDirs []string) (bool, []string, error)
• func FindReadmes(basePath, readmeName string, excludeDirs []string) (map[string]string, error)
• func ReadmeMD(pkgName string, writer io.Writer) error
• func VerifyReadme(pkgName, readmePath string) (bool, error)
• func WriteReadme(pkgName, readmePath string) (err error)

Functions

func CheckReadmes

func CheckReadmes(basePath, readmeName string, excludeDirs []string) (bool, []string, error)

CheckReadmes checks that the readmes in basePath are up to date the first return value is a boolean indicating whether all readmes are up to date (false if any are outdated) the second return is the list of outdated readmes found

func FindReadmes

func FindReadmes(basePath, readmeName string, excludeDirs []string) (map[string]string, error)

FindReadmes finds all goreadme generated README.md files in basePath and child directories

returns a map of filepath:package

func ReadmeMD

func ReadmeMD(pkgName string, writer io.Writer) error

ReadmeMD writes readme content for the given package to writer

func VerifyReadme

func VerifyReadme(pkgName, readmePath string) (bool, error)

VerifyReadme checks that the file at readmePath has the correct content for pkgName

func WriteReadme

func WriteReadme(pkgName, readmePath string) (err error)

WriteReadme writes a README.md for pkgname to the given path