add docs.

2026-11-02 22:51:34 -06:00 · 2021-03-12 11:00:30 +01:00
parent f79da7995a
commit 864236f0c9
4 changed files with 9 additions and 3 deletions
@@ -1,12 +1,18 @@
 # neko-rooms

-Simple room management system for [n.eko](https://github.com/m1k1o/neko).
+Simple room management system for [n.eko](https://github.com/m1k1o/neko). Self hosted rabb.it alternative.
+
+![rooms](docs/rooms.png)
+
+![new room](docs/new_room.png)
+
+![n.eko](docs/neko.gif)

 ## How to start

-You need to have installed `Docker` and `docker-compose`.
+You need to have installed `Docker` and `docker-compose`. You need to have custom domain pointing to your server's IP.

-You can watch this installation video provided by *Dr R1ck*:
+You can watch installation video provided by *Dr R1ck*:

 https://www.youtube.com/watch?v=cCmnw-pq0gA