/readme-template

ReadMe.md template

Apache License 2.0Apache-2.0

  _____  ______          _____  __  __ ______ 
 |  __ \|  ____|   /\   |  __ \|  \/  |  ____|
 | |__) | |__     /  \  | |  | | \  / | |__   
 |  _  /|  __|   / /\ \ | |  | | |\/| |  __|  
 | | \ \| |____ / ____ \| |__| | |  | | |____ 
 |_|  \_\______/_/    \_\_____/|_|  |_|______|

 generated by: https://patorjk.com/software/taag/

README.md Template

language:language

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut turpis nibh, pulvinar at nulla vitae, volutpat cursus mauris. Donec vel maximus neque. Suspendisse et vulputate tortor.

Objectives

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Environment Variables

Required environment variables:

Name Example Description
CONTEXT dev, prod environment
DB_HOST localhost database host
DB_USER dev database user
DB_NAME test database name
DB_PASSWORD password database password

Running locally

[TODO]

Building

[TODO]

Testing

[TODO]

Deployment

[TODO]

License

[TODO]

Version

0.0.1

Contributing

  1. Fork it (https://github.com/ethandunford/readme-template/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors