README.MD

Auto-generate README.md from a template

The README.md file in this project is autogenerated using the excellent @appnest/readme library. To auto-generate the README.md file, follow the below steps

• Update package.json name with title of your project. This is used as the README's title
• Update the blueprint.md file as you would normally update your README file. This file will serve as the template to auto-generate the project's README.md file
• if necessary, make changes to the blueprint.json file
  • The blueprint.json file can be used to configure your README's logo and badges among other things
• Execute the below command to autogenerate the README.md file. The blueprint.md and blueprint.json will be merged to generate an elegant README.md file

foo@bar:~$: npx @appnest/readme generate
[readme] - A readme file was successfully generated at "README.md".

The README.md is now generated and can be added to your github repository.

To configure your project's badges, please read Project Documentation And Metrics