From 5612b806345f4d1a509a68beda074fa2dea7007f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20=C5=A0ediv=C3=BD?= Date: Mon, 1 Aug 2022 00:26:53 +0200 Subject: [PATCH] add README. --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb4b5bc1..290d3623 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ -# n.eko core +# neko +This app uses WebRTC to stream a desktop inside of a docker container. Client can be found here: [demodesk/neko-client](https://github.com/demodesk/neko-client). -Virtual environment backend. +For **community edition** neko with GUI and _plug & play_ deployment visit [m1k1o/neko](https://github.com/m1k1o/neko). + +### **m1k1o/neko** vs **demodesk/neko**, why do we have two of them? + +This project started as a fork of [m1k1o/neko](https://github.com/m1k1o/neko). But over time, development went way ahead of the original one in terms of features, updates and refactoring. The goal is to rebase [m1k1o/neko](https://github.com/m1k1o/neko) repository onto this one and move all extra features (such as chat and emotes) to a standalone plugin. + +- This project is aimed to be the engine providing foundation for all applications that are streaming desktop environment using WebRTC to the browser. +- [m1k1o/neko](https://github.com/m1k1o/neko) is meant to be self-hosted replacement for [rabb.it](https://en.wikipedia.org/wiki/Rabb.it): Community edition with well-known GUI, all the social functions (such as chat and emotes) and easy deployment. + +Notable differences to the [m1k1o/neko](https://github.com/m1k1o/neko) are: + +- Go plugin support. +- Multiple encoding qualities simulcast. +- Single cursor for host - cursor image proxying. +- Custom cursor style/badge for participants. +- Inactive cursors (participants that are not hosting). +- Fallback mode and reconnection improvements: + - Watching using screencasting. + - Controlling using websockets. +- Members handling: + - Access control (view, interactivity, clipboard). + - Posibility to add external members providers. + - Persistent login (using cookies). + - Split members and sessions. +- Drag and drop passthrough. +- File upload passthrough (experimental). +- Microphone passthrough. +- Webcam passthrough (experimental). +- Bi-directional text/html clipboard. +- Keyboard layouts/variants. + +## Docs + +*TBD.*