kessler / license-report

create a short report about a project's dependencies (license, url etc)
MIT License
236 stars 39 forks source link

List all fields from config.json and their datasource in README.md #23

Closed BePo65 closed 4 years ago

BePo65 commented 4 years ago

Today you can find out about the available fields only by looking into the source code.

Wouldn't it be easier, if the README.md listed all the field names? Additionally this would be a fine place to describe that the fields 'department', 'relatedTo', 'licensePeriod' and 'material' must be set by the command line and that the field 'comment' contains the most recent version number for this package in the repository.