jonny_bro/discord-player-play-dl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update readme and docs

Browse source
This commit is contained in:
Androz2091 2020-01-11 20:13:09 +01:00
parent 527bd56ea1
commit 455da9b830
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -6,7 +6,7 @@
**Note**: this module uses recent discordjs features and requires discord.js version 12. **Note**: this module uses recent discordjs features and requires discord.js version 12.
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! 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**!
- [Installation](#installation) - [Installation](#installation)
- [Player](#player) - [Player](#player)
@ -57,9 +57,9 @@ client.on("ready", () => {
client.login(settings.token); client.login(settings.token);
``` ```
You can pass a third parameter when instantiating the class Player: the **options** object: 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.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. **options.leaveOnStop**: whether the bot should leave the voice channel when the `stop()` function is used.
### Play ### Play

6
docs/index.html
View file

@ -53,7 +53,7 @@
<a href="https://npmjs.com/discord-player"><img src="https://img.shields.io/npm/v/discord-player?style=for-the-badge" alt="versionBadge"></a> <a href="https://npmjs.com/discord-player"><img src="https://img.shields.io/npm/v/discord-player?style=for-the-badge" alt="versionBadge"></a>
<a href="https://patreon.com/Androz2091"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2FAndroz2091%2Fpledges&amp;style=for-the-badge" alt="patreonBadge"></a></p> <a href="https://patreon.com/Androz2091"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2FAndroz2091%2Fpledges&amp;style=for-the-badge" alt="patreonBadge"></a></p>
<p><strong>Note</strong>: this module uses recent discordjs features and requires discord.js version 12.</p> <p><strong>Note</strong>: this module uses recent discordjs features and requires discord.js version 12.</p>
<p>Discord Player is a powerful <a href="https://nodejs.org">Node.js</a> module that allows you to easily implement music commands. Everything is customizable, and everything is done to simplify your work without limiting you!</p> <p>Discord Player is a powerful <a href="https://nodejs.org">Node.js</a> module that allows you to easily implement music commands. <strong>Everything</strong> is customizable, and everything is done to simplify your work <strong>without limiting you</strong>!</p>
<ul> <ul>
<li><a href="#installation">Installation</a></li> <li><a href="#installation">Installation</a></li>
<li><a href="#player">Player</a> <li><a href="#player">Player</a>
@ -98,8 +98,8 @@ client.on(&quot;ready&quot;, () => {
client.login(settings.token); client.login(settings.token);
</code></pre> </code></pre>
<p>You can pass a third parameter when instantiating the class Player: the <strong>options</strong> object: <p>You can pass a third parameter when instantiating the class Player: the <strong>options</strong> object:<br>
<strong>options.leaveOnEnd</strong>: whether the bot should leave the voice channel when there is no more song in the queue. <strong>options.leaveOnEnd</strong>: whether the bot should leave the voice channel when there is no more song in the queue.<br>
<strong>options.leaveOnStop</strong>: whether the bot should leave the voice channel when the <code>stop()</code> function is used.</p> <strong>options.leaveOnStop</strong>: whether the bot should leave the voice channel when the <code>stop()</code> function is used.</p>
<h3>Play</h3> <h3>Play</h3>
<p>To play a song, use the <code>client.manager.play()</code> function.</p> <p>To play a song, use the <code>client.manager.play()</code> function.</p>