monaqvi / Doctor_Readme

A useful README template.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Doctor Readme

A template package and guide for high-quality readmes.

Usage

Fork, clone, or download this template package to create useful README documentation for your project.

Files

README.md is the sample README template you can format to your specifications. It has direct links to ENDPOINTS.md and GITFLOW.md.

ENDPOINTS.md is a sample API documentation template.

GITFLOW.md is a sample git workflow template.

Contributing

We would love for you to contribute to this package to make this helpful for everyone creating open-source projects. Please see the outstanding issues for open tasks and read the Contributing workflow.

Questions and Issues

To report any issues, please refer to our issues page Please direct any questions regarding Doctor Readme to Chris Bassano.

About

A useful README template.