From bd7f8a5126c854e03ac06225d600f8083c143a02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20=C5=A0ediv=C3=BD?= Date: Sun, 30 Mar 2025 22:48:41 +0200 Subject: [PATCH] update readme. --- README.md | 115 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 63 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 2012f0c9..e1fbad7b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- +

@@ -22,10 +22,10 @@ Chat on discord - build + build

- +
# n.eko @@ -83,47 +83,60 @@ Compared to clientless remote desktop gateway (e.g. [Apache Guacamole](https://g ### Supported browsers
- - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ... see [all available images](https://neko.m1k1o.net/docs/v3/installation/docker-images)
-### Other programs +### Other applications
- - - - + + + + + + + + + + + + ... others in m1k1o/neko-apps
-### Features - - * Text Chat (With basic markdown support, discord flavor) - * Admin users (Kick, Ban & Force Give/Release Controls, Lock room) - * Clipboard synchronization (on [supported browsers](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/readText)) - * Emote overlay - * Ignore user (chat and emotes) - * Persistent settings - * Automatic Login with custom url args. (add `?usr=&pwd=` to the url.) - * Broadcasting room content using RTMP (to e.g. twitch or youtube...) - * Bidirectional file transfer (if enabled) - -
- -With `NEKO_FILE_TRANSFER_ENABLED=true`: - - -
- -### Why n.eko? +### Why neko? I like cats 🐱 (`Neko` is the Japanese word for cat), I'm a weeb/nerd. @@ -131,28 +144,26 @@ I like cats 🐱 (`Neko` is the Japanese word for cat), I'm a weeb/nerd. ## Multiple rooms -For n.eko room management software, visit [neko-rooms](https://github.com/m1k1o/neko-rooms). +For neko room management software, visit [neko-rooms](https://github.com/m1k1o/neko-rooms). -It also offers zero-knowledge [installation script (with HTTPS and Traefik)](https://github.com/m1k1o/neko-rooms/#zero-knowledge-installation-with-https-and-traefik). +It also offers [Zero-knowledge installation (with HTTPS)](https://github.com/m1k1o/neko-rooms/?tab=readme-ov-file#zero-knowledge-installation-with-https). ## Documentation -* [Getting Started](https://neko.m1k1o.net/#/getting-started/) - * [Quick Start](https://neko.m1k1o.net/#/getting-started/quick-start) - * [Examples](https://neko.m1k1o.net/#/getting-started/examples) - * [Reverse Proxy](https://neko.m1k1o.net/#/getting-started/reverse-proxy) - * [Configuration](https://neko.m1k1o.net/#/getting-started/configuration) - * [Troubleshooting](https://neko.m1k1o.net/#/getting-started/troubleshooting) -* [Mobile Support](https://neko.m1k1o.net/#/mobile-support) -* [Contributing](https://neko.m1k1o.net/#/contributing) - * [Non Goals](https://neko.m1k1o.net/#/non-goals) - * [Technologies](https://neko.m1k1o.net/#/technologies) -* [Changelog](https://neko.m1k1o.net/#/changelog) +Full documentation is available at [neko.m1k1o.net](https://neko.m1k1o.net/). Key sections include: -## How to contribute? How to build? +- [Migration from V2](https://neko.m1k1o.net/docs/v3/migration-from-v2) +- [Getting Started](https://neko.m1k1o.net/docs/v3/quick-start) +- [Installation](https://neko.m1k1o.net/docs/v3/installation) +- [Examples](https://neko.m1k1o.net/v3/installation/examples) +- [Configuration](https://neko.m1k1o.net/docs/v3/configuration) +- [Frequently Asked Questions](https://neko.m1k1o.net/docs/v3/faq) +- [Troubleshooting](https://neko.m1k1o.net/docs/v3/troubleshooting) -Navigate to [.docker](.docker) folder for further information. +## How to Contribute + +Contributions are welcome! Check the [Contributing Guide](https://neko.m1k1o.net/contributing) for details. ## Support -If you want to support this project, you can do it [here](https://github.com/sponsors/m1k1o). +If you find Neko useful, consider supporting the project via [GitHub Sponsors](https://github.com/sponsors/m1k1o).