Skip to content

nypl-spacetime/generate-etl-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

generate-etl-readme

Node.js module to generate Markdown README files for NYC Space/Time Directory’s ETL modules.

Examples

Usage

First, install generate-etl-readme as dependency:

npm install --save-dev spacetime-generate-etl-readme

Then, the following line to the scripts section of the ETL script’s package.json:

"scripts": {
  ...
  "readme": "spacetime-generate-etl-readme -o README.md ./"
}

Generate a new README.md by running:

npm run readme

Including extra, module-specific content to a README file

To include extra content in the generated README.md file, add this content to <datasetId>.md in the module's directory.

See also

About

Generates README markdown files for Space/Time ETL scripts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published