diff --git a/README.md b/README.md index 6d90166a..c25eeb98 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,46 @@ -Read before submitting an issue: https://github.com/calzoneman/sync/wiki/Reporting-an-Issue -=========================================================================================== +CyTube +====== -calzoneman/sync -=============== +CyTube is a project I started in early 2013 as a hobby project to build my own +clone of synchtube.com (now defunct). -About ------ +The basic concept is that users register channels where connected viewers can +watch videos from different video hosts (e.g., YouTube, Twitch) and the playback +is synchronized for all the viewers in the channel. -CyTube is a web application providing media synchronization, chat, and more for an arbitrary number of channels. -I began developing this as a hobby project, and when synchtube.com announced their closure, I -began polishing it and readying it for the public. +Each channel has a playlist where users can queue up videos to play, as well as +an integrated chatroom for discussion. -I am hosting a CyTube server at http://cytu.be +The official server is located at https://cytu.be, but there are other public +servers hosted for various communities. -The serverside is written in JavaScript and runs on Node.JS. It makes use -of a MySQL database to store user registrations, cached media metadata, and -data about each channel. +## Installation -The clientside is written in JavaScript and makes use of Socket.IO and -jQuery as well as the APIs for various media providers. -The web interface uses Bootstrap for layout and styling. +The installation guide for server administrators is located [on the +wiki](https://github.com/calzoneman/sync/wiki/CyTube-3.0-Installation-Guide). -Features --------- -- Standalone web/socket.io server -- Optional SSL support for socket.io and the account API -- Synchronized playback from the following sources: - - YouTube (individual videos + playlists) - - Google Docs videos - - Vimeo - - Dailymotion - - Soundcloud - - Raw video/audio files (via video.js) -- Embedding of the following sources: - - livestream.com - - twitch.tv - - justin.tv - - ustream.tv - - RTMP streams - - Custom `