From 2b5bcddf55fe80e21335f8d3b634ff1a560f3d02 Mon Sep 17 00:00:00 2001 From: grimsi <9295182+grimsi@users.noreply.github.com> Date: Sun, 15 Jun 2025 17:47:57 +0200 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0ae7ed1..f388138 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ > [!IMPORTANT] -> Gameyfin v2 is still under heavy development and far from feature complete. -> You can check the current progress [here](https://github.com/gameyfin/gameyfin/pull/280). +> Gameyfin v2 currently in beta stage. +> Expect bugs and breaking changes until the `2.0.0` release. ## Overview @@ -23,22 +23,19 @@ Name and functionality inspired by [Jellyfin](https://jellyfin.org/). 🔌 Easily expandable with plugins 🔒 Integrates into your SSO solution via OAuth2 / OpenID Connect -### Screenshots +### Documentation -`Work in progress` - -### Installation - -`Work in progress` +The documentation is available at [gameyfin.org](https://gameyfin.org/). ### Contribute to Gameyfin -`Work in progress` +Currently, no contribution guide is available. After the `2.0.0` release, contributions will be welcome. + +### Technical Details Gameyfin v2 is written in Kotlin and uses the following libraries/frameworks: * Spring Boot 3 for the backend -* Vaadin for the frontend +* Vaadin Hilla & React for the frontend * PF4J for the plugin system * H2 database for persistence -* Micrometer and Prometheus for monitoring