Maven Readme.md file generator
Run
npx mvn-readme-md-generator [args]Description
Maven readme.md file generator works by looking into the pom.xml
file and '/src/main/resources' properties directory to get project
meta-data that will be used in to the process.
The command line tool asks you some describing questions that will
be used as data for the readme.md file. Current implementation supports
generator functionality for maven projects with no sub modules.
In the next versions we will come with functionality for generating
Readme.md parent file that will reference all children readme.md generated
files from maven sub modules.
Help
Args:
--path: [string] custome .md template path to be used
--propDir: [string] custome .properties/.yml files directory where meta-data
will be extracted
--ymlProp: [boolean] looking for .yml prop files when extracts project meta-data
Usage:
npx mvn-readme-md-generator - Run command with default arguments
npx mvn-readme-md-generator
--path [custome-md-template-path]
--propDir [other-path-for-props-dir]
--ymlProp [true] - Run command with custome parameters
License & Copyright
MIT-Style License
Copyright (c) Pancu Daniel
codesquad-dev team