Documentation Rework

[SpoopyTim]

Lets work on the documentation!

We need step-by-step installation for a basic setup with more advanced config options for expanding on the basic setup, as well as more straightforward and organised contribution guidelines.

Below is the structure that would be ideal. Feel free to suggest anything that needs adding or changing.

• Logo
• Badges (Discord, CI Status, Stargazers, License, PR's, Issues, Contributers)
• Tagline
• Table of Contents
• Introduction
  • About
  • Use Cases & Architecture
  • Roadmap
• Getting Started
  • Prerequisites
  • Project Structure
  • Instructions
• Configuration
  • Environment Variables
  • Port Mappings / Firewall
  • Config File
  • CLI Usage
  • Additional Notes
• Contributing
  • Links to other documents (PULL-REQUESTS.md, CONTRIBUTING.md, LICENSE.md)
  • Contribution Steps
• Acknowledgements

For each point make sure that it follows these guidelines

• Is concise and to the point (Exceptions include anything under Introduction)
• Is gramatically correct
• Uses good-looking markdown (where applicable)

[Meister1593]

I think configuration section needs firewall/port forwarding , to know exactly which ports you need to open by default, how to change them.

Good to know that project is still alive!

[SpoopyTim]

I think configuration section needs firewall/port forwarding , to know exactly which ports you need to open by default, how to change them.

Added! Thanks for the contribution