discord-player - npm Package Compare versions

Comparing version 1.0.0 to 1.0.2

package.json

 {
   "name": "discord-player",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Complete framework to facilitate music commands using discord.js v12",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,5 +0,5 @@
-# Discord Music
+# Discord Player
 
-[![downloadsBadge](https://img.shields.io/npm/dt/discord-music?style=for-the-badge)](https://npmjs.com/discord-music)
-[![versionBadge](https://img.shields.io/npm/v/discord-music?style=for-the-badge)](https://npmjs.com/discord-music)
+[![downloadsBadge](https://img.shields.io/npm/dt/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)
+[![versionBadge](https://img.shields.io/npm/v/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)
 [![patreonBadge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2FAndroz2091%2Fpledges&style=for-the-badge)](https://patreon.com/Androz2091)
@@ -9,3 +9,3 @@
 
-Discord Music is a powerful [Node.js](https://nodejs.org) module that allows you to easily implement music commands. Everything is customizable, and everything is done to simplify your work without limiting you!
+Discord Player is a powerful [Node.js](https://nodejs.org) module that allows you to easily implement music commands. Everything is customizable, and everything is done to simplify your work without limiting you!
 
@@ -28,3 +28,3 @@ - [Installation](#installation)
 ```sh
-npm install --save discord-music
+npm install --save discord-player
 ```
@@ -49,7 +49,5 @@
 
-const { Player } = require('discord-music');
-const player = new Player(client, "YOUTUBE API KEY", {
-    leaveOnEnd: true,
-    leaveOnStop: true
-});
+const { Player } = require('discord-player');
+// Create a new Player (Youtube API key is your Youtube Data v3 key)
+const player = new Player(client, "YOUTUBE API KEY");
 // To easily access the player
@@ -65,2 +63,6 @@ client.player = player;
 
+You can pass a third parameter when instantiating the class Player: the **options** object:
+**options.leaveOnEnd**: whether the bot should leave the voice channel when there is no more song in the queue.
+**options.leaveOnStop**: whether the bot should leave the voice channel when the `stop()` function is used.
+
 ### Play
@@ -67,0 +69,0 @@

No alert changes

Improved metrics

Total package byte prevSize

25416

increased by1.36%

Number of lines in readme file

347

increased by0.58%

No dependency changes