🔖 0.4.0

niksudan · Aug 14, 2020 · 766ffc3 · 766ffc3
1 parent 9bf7a59
commit 766ffc3
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/INSTALLATION.md b/INSTALLATION.md
@@ -33,8 +33,8 @@ https://discordapp.com/developers/applications/123456/bot
 
 Copy the number right before `/bot` and paste it after the `client_id` variable in this URL:
 
-```
-https://discordapp.com/api/oauth2/authorize?client_id=<CLIENT_ID_HERE>&permissions=0&scope=bot
+```sh
+https://discordapp.com/api/oauth2/authorize?client_id=$CLIENT_ID_HERE&permissions=0&scope=bot
 ```
 
 Visit the link in your browser, and you should be able to invite the bot to your Discord server.
@@ -64,6 +64,8 @@ You will need to [enable developer mode](https://www.discordia.me/en/developer-m
 | `MUSIC_SOURCE_CHANNEL_ID`      | Discord channel ID where to get songs from   | Right click on the channel                                                                                  |
 | `MUSIC_DESTINATION_CHANNEL_ID` | Discord channel ID where to post playlist to | Right click on the channel                                                                                  |
 
+The `ENVIRONMENT` is an optional variable. If defined and set as `development`, the playlist will not update, and a message will not send to the channel.
+
 ## First Time Setup
 
 If everything worked correctly, you may now run `yarn generate-playlist` in this directory.

diff --git a/README.md b/README.md
@@ -15,9 +15,17 @@ Song are added to the playlist if it is in one of the following formats:
 
 After each new playlist, a message is posted to a channel that will show the following information:
 
-- Top 5 artists
-- Top 5 genres
-- Top 5 contributors
+- Popular artists (with total tracks)
+- Dominant genres (with percentages)
+- Most liked tracks (with total like score)
+- Top contributors (with total contributions)
+- Number of tracks & playlist link
+
+## Reacting to Songs
+
+If a song gets reacted with a 👍, this is counted as a **like**. The more likes a song gets, the higher it will appear in the playlist.
+
+If a song gets reacted with a 👎, this is counted as a **dislike**. This subtracts from the total number of likes. If a song is disliked enough, it will not appear in the playlist.
 
 ## Installation
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "discord-weekly",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "author": "Nik Sudan",
   "license": "MIT",
   "dependencies": {