From f0d44b76f80e216ca0650fdfae4c49f491926537 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kasper=20Rynning-T=C3=B8nnesen?= Date: Wed, 22 Nov 2017 10:45:32 +0100 Subject: [PATCH] Added two new events in README.md, and how zoff is pronounced (README.md and about-modal) --- README.md | 2 +- server/README.md | 8 +++++++- server/public/partials/modal/about.handlebars | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b760421a..4fd3fe26 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Zoff ==== -Zoff is a shared (free) YouTube based radio service, built upon the YouTube API, with integrated casting with Chromecast. +Zoff (pronounced __søff__) is a shared (free) YouTube based radio service, built upon the YouTube API, with integrated casting with Chromecast. ## Install diff --git a/server/README.md b/server/README.md index 56b89cc8..3712bdb1 100644 --- a/server/README.md +++ b/server/README.md @@ -46,6 +46,9 @@ // Sends message to the host channel to change channel 'id', {id: CHANNEL_ID, type: "channel", value: NEW_CHANNEL_NAME} + +// Sends a video that triggered an error +'error_video', {channel: CHANNE_NAME, id: VIDEO_ID, title: VIDEO_TITLE} ``` ### From server @@ -71,7 +74,7 @@ // Receives the messages sent on CHANNEL_ID above id, {type: STRING, value: VALUE} -// Receives updates from channel. type is one of the following: list, added, deleted, vote, song_change +// Receives updates from channel. type is one of the following: list, added, deleted, vote, song_change, changed_values (see further down for better explanation here) 'channel', {type: TYPE, value: value, time: time_of_occurence} // Receives message from the server that its ready to send the playlist and info @@ -82,4 +85,7 @@ id, {type: STRING, value: VALUE} // Receives number of viewers on the current channel 'viewers', VALUE + +// Receives a newly updated video, that was checked for errors (song_generated contains .id which is the current id of the video, and a .new_id for the new video to change the video to) +'channel', {type: "changed_values", value: song_generated} ``` diff --git a/server/public/partials/modal/about.handlebars b/server/public/partials/modal/about.handlebars index 08d593a6..ac55dad9 100644 --- a/server/public/partials/modal/about.handlebars +++ b/server/public/partials/modal/about.handlebars @@ -1,7 +1,7 @@