README.md

project_name

project_description
Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Example
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Here's a place to insert the description of the project

(back to top)

Getting Started

Here's a place on explaining how to get started with the project

Prerequisites

These are required to getting started with project_name

• python

Installation

This is how you install project_name

1. Install the package off PyPI

   pip install project_name

(back to top)

Usage

Underneath is how you get started using project_name

For more examples, please refer to Documention

Example

import project_name

(back to top)

Roadmap

• [] Feature 1
• [] Feature 2
  • [] Nested Feature

Please refer to open issues for a larger list of proposed features (and know issues)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

• On Twitter - author
• On Discord - discord_tag

(back to top)

Acknowledgements

• Img Shields
• GitHub Pages
• Font Awesome
• blah blah blah....

(back to top)