Added two new events in README.md, and how zoff is pronounced (README.md and about-modal)

This commit is contained in:
Kasper Rynning-Tønnesen
2017-11-22 10:45:32 +01:00
parent 181d9741e2
commit f0d44b76f8
3 changed files with 9 additions and 3 deletions

View File

@@ -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

View File

@@ -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}
```

View File

@@ -1,7 +1,7 @@
<div id="about" class="modal">
<div class="modal-content">
<h4>About</h4>
<p>Zoff is a shared (free) YouTube based radio service, built upon the YouTube API. <br><br>
<p>Zoff (pronounced <b>søff</b>) is a shared (free) YouTube based radio service, built upon the YouTube API. <br><br>
Zoff is mainly a web-based service. The website uses NodeJS with Socket.IO, MongoDB and express on the backend, with JavaScript, jQuery and Materialize on the frontend.<br><br>
The team consists of Kasper Rynning-Tønnesen and Nicolas Almagro Tonne, and the project has been worked on since late 2014.<br><br>
</p>