iridium/neko
2
2
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2024-07-24 14:40:50 +12:00
Code Issues Packages Projects Releases Wiki Activity

basic documentation

Browse Source
This commit is contained in:
Craig
2020-01-29 01:28:27 +00:00
parent 9e4e427779
commit 6d95aec28c
4 changed files with 98 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
client/ABOUT.md
View File

@ -3,11 +3,10 @@
</div>
# **n**.eko
This app uses Web RTC to stream a desktop inside of a docker container, I made this because [rabb.it](https://en.wikipedia.org/wiki/Rabb.it) went under and my internet can't handle streaming and discord keeps crashing. I just want to watch anime with my friends ლ(ಠ益ಠლ) so I started digging throughout the net and found a few *kinda* clones, but non of them had the virtual browser, then I found [Turtus](https://github.com/Khauri/Turtus) and I was able to figure out the rest. This is by no means a fully featured clone of rabbit, it hs only *one* room. Its stateless, so no saved user names or passwords.
This app uses Web RTC to stream a desktop inside of a docker container, I made this because [rabb.it](https://en.wikipedia.org/wiki/Rabb.it) went under and my internet can't handle streaming and discord keeps crashing when my friend attempts to. I just want to watch anime with my friends ლ(ಠ益ಠლ) so I started digging throughout the internet and found a few *kinda* clones, but none of them had the virtual browser, then I found [Turtus](https://github.com/Khauri/Turtus) and I was able to figure out the rest. This is by no means a fully featured clone of rabbit, it hs only *one* room. It's stateless, so no saved user names or passwords.
### Why n.eko?
I like cats (Neko is the Japanese word for cat), I'm a weeb/nerd
### Why **n**.eko?
I like cats 🐱 (`Neko` is the Japanese word for cat), I'm a weeb/nerd
### Why the cat butt?
Because cats are *assholes*, but you love them anyways...
***But why the cat butt?*** Because cats are *assholes*, but you love them anyways.

15
client/README.md
View File

@ -1 +1,14 @@
# n.eko Client
# **n**.eko client
Web client for n.eko
### Environment
------
```
VUE_APP_SERVER_PORT // development server port
```
### Building
------
```
npm install && npm run build
```