From a948626ba56542bf1cccdb26bf202c7306f5cc9a Mon Sep 17 00:00:00 2001 From: Thegan Govender Date: Mon, 3 Apr 2023 11:57:05 +0200 Subject: [PATCH] Create README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3d30f8 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +

+ +**Jellystat** is a free and open source Statistics App for Jellyfin! + +## Current Features + +- Session Monitoring anf logging +- Statistics for all Libraries and Users +- Watch History +- User Overview and activity +- Watch statisitcs + +## Required Development +- Responsive UI +- Code Optimizations +- Security Testing +- More Validations and Error Handling +- Auto sync library items +- Stats for Library Items (Eg Movies etc) +- More to come + +## Getting Started + +### Launching Jellystat using Docker + +Check out our dockerhub to run Jellystat: +https://hub.docker.com/r/cyfershepard/jellystat + +## Support + +- Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/CyferShepard/Jellystat/issues). + +## API Documentation + +To-do