README Template

Template for creating readme files.

A README file contains information about the other files in a directory or archive of computer software. A form of documentation, it is usually a simple plain text file called README, Read Me, READ.ME, README.TXT, README.md (to indicate the use of Markdown), or README.1ST. Wikipedia

Demo

https://github.com/raphaelbh/readme-template

Requirements

Installation

$ docker run -p 5000:5000 -e PORT=5000 -d raphaelbh/timezone-api

Usage

$ curl http://localhost:5000/api

Running Tests

$ pytest --cov=app tests/

Project Structure

.
├── build                   # Compiled files (alternatively `dist`)
├── docs                    # Documentation files (alternatively `doc`)
├── src                     # Source files (alternatively `lib` or `app`)
├── test                    # Automated tests (alternatively `spec` or `tests`)
├── tools                   # Tools and utilities
├── LICENSE
└── README.md

Tech Stack

Reference

• https://github.com/raphaelbh/readme-template
• https://shields.io/
• https://github.com/alexandresanlim/Badges4-README.md-Profile

Feedback

If you have any feedback, please contact me at [email protected]