From 86be67ad12505dde4c5a72b85565402c84cff31b Mon Sep 17 00:00:00 2001 From: Wanjohi <71614375+wanjohiryan@users.noreply.github.com> Date: Sun, 27 Oct 2024 01:40:57 +0300 Subject: [PATCH] docs: Update README (#122) Update the README --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80ec8b2e..1993f08e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@

+ Nestri - What will you play next? @@ -12,7 +13,7 @@     -Nestri is an open-source, self-hosted cloud gaming platform that allows you to play games in your web browser with friends. Built and shaped by our gaming community. +Nestri is an open-source, self-hosted Geforce Now alternative with Stadia's social features. Built and shaped by our gaming community.

@@ -34,7 +35,59 @@ Nestri is an open-source, self-hosted cloud gaming platform that allows you to p     -> More info coming soon! +> **Note** +> Nestri is more closer (in feature comparison) to Jellyfin/Plex than Moonlight. Our goal is to develop a comprehensive self-hosted cloud gaming solution for your home server. + +## Features + +- Save and share your game progress easily with friends +- Simultaneously run multiple games on your GPU using Virtio-GPU Venus and/or Virgl +- Play games using either your integrated GPU or dedicated GPU +- Enjoy titles from your preferred Game Stores - Steam, Epic Games, Amazon Games, GOG.com +- Experience Android gaming +- Organize gaming sessions with friends and family through Nestri Parties +- Stream directly to YouTube and Twitch straight from your setup +- Family sharing capabilities +- Support for Controller, Touchscreen, Keyboard, and Mouse devices + +## Possible Use Cases + +- Organize game nights or LAN parties with friends online or locally +- For game developers, showcase your proof-of-concept multiplayer games for testing without installation +- Create and manage your custom cloud-gaming platform using our robust API +- Establish a game server for your family to enjoy gaming on the go + +## Goals + +- Provide a user-friendly setup - fire and forget +- Deliver a simple and elegant interface for managing and playing your game library +- Ensure a high-quality gaming experience out-of-the-box +- Optimize for the best gaming performance right from the start + +## Non-Goals + +- Become a generic cloud-gaming service + +## Built With + +- Cloudflare Workers +- Cloudflare Pages +- Supabase +- CrosVM (with Virtio-GPU Venus and Virgl support) +- Docker +- Qwik +- Media-Over-Quic +- AWS Route53 + +## Known Issues + +- CrosVM is still under development and needs to be merged +- Currently, the Intel dGPU, particularly the Arc A780, is the only tested and verified GPU + +## Donation + +If you appreciate our work and wish to support the development of Nestri, consider making a donation [here](https://polar.sh/nestri/donate). Your contributions will help us improve the platform and enhance your gaming experience. Thank you for your support! + [github-release-link]: https://github.com/nestriness/nestri/releases