${REPO_NAME}

[?] Switch for your own logo

${REPO_DESCRIPTION}
Report a Bug · Request a Feature · Ask a Question

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Support
• Roadmap
• Project Help
• Contributing
• Acknowledgements
  • Funding Organizations
  • Patrons
  • Software Used
  • Inspirations
  • Authors and Contributors
• Security
• License

About

[?] Provide general information about your project here. What problem does it (intend to) solve? What is the purpose of your project? Why did you undertake it?

Back to top

Getting Started

Prerequisites

[?] List project requirements or dependencies. List build tools.

Back to top

Installation

[?] Describe how to install and get started with the project. List build instructions.

Back to top

Usage

[?] How does one go about using it? Provide various use cases and code examples here.

Back to top

Support

[?] Provide additional ways to contact the project maintainer/maintainers. Website? Email?

Back to top

Roadmap

See the open issues for a list of proposed features (and known issues).

[?] Show milestones. Top Feature Requests. (Add your votes using the 👍 reaction) Newest Bugs. (Add your votes using the 👍 reaction) Kanban board or other project management software.

Back to top

Project Help

If you want to say thank you and/or support active development of ${REPO_NAME}:

• Add a GitHub Star to the project's GitHub awareness page. This is not a mirror to prevent GitHub Copilot.
• Tweet about ${REPO_NAME} or spread the word on other social media.
• Write interesting articles about the project on Dev.to, Medium, or your personal blog.
• Help fund our contributors on:
  • Liberapay
  • Buy me a coffee
  • Ko-Fi
  • Patreon
  • Kickstarter
  • Indiegogo

[?] Replace with links to the projects own funding pages.

Together, we can make ${REPO_NAME} better!

Back to top

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Back to top

Acknowledgements

Funding Organizations

[?] Include any organizations or companies that are funding the project.

Back to top

Patrons

All patrons can be found at:

• Liberapay
• Buy me a coffee
• Ko-Fi
• Patreon
• Kickstarter
• Indiegogo

[?] Replace with links to own funding pages w/ patrons listed.

Back to top

Software Used

• The Amazing Github Template for the README.md and some other documents.

[?] Include libraries and applications used in the project.

Back to top

Inspirations

[?] Include any projects or people that have inspired this project.

Back to top

Authors and contributors

The original setup of this repository is by ${REPO_OWNER}.

For a full list of all authors and contributors, see the contributors page.

[?] Replace once w/ contributors once https://github.com/go-gitea/gitea/issues/847 is implemented.

Back to top

Security

${REPO_NAME} follows good practices of security, but 100% security cannot be assured. ${REPO_NAME} is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

Back to top

License

Copyright (C) 2022 Clayton Voges

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/

Back to top