diff --git a/README.md b/README.md index 47d2953..eaf96bf 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/neko.gif b/docs/neko.gif new file mode 100644 index 0000000..cf56565 Binary files /dev/null and b/docs/neko.gif differ diff --git a/docs/new_room.png b/docs/new_room.png new file mode 100644 index 0000000..12e3f17 Binary files /dev/null and b/docs/new_room.png differ diff --git a/docs/rooms.png b/docs/rooms.png new file mode 100644 index 0000000..aba405b Binary files /dev/null and b/docs/rooms.png differ