aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authors1n <[email protected]>2020-04-12 06:16:29 -0700
committerGitHub <[email protected]>2020-04-12 06:16:29 -0700
commitb3d868f15b48379ceee2c2e7270bae1830f1dd0c (patch)
treebbb81dff7a8c7216e3290e6da3818479ecafb086
parentThe Beginning, v1.0.0 (diff)
downloadminecraftsoundtrackbot-b3d868f15b48379ceee2c2e7270bae1830f1dd0c.tar.xz
minecraftsoundtrackbot-b3d868f15b48379ceee2c2e7270bae1830f1dd0c.zip
Create README.md
-rw-r--r--README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2391d54
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# The Minecraft Soundtrack Bot
+
+The Minecraft Sountrack Bot is a Discord bot which allows you to play the Minecraft sountrack in your Discord server with ease.
+
+ - Full Minecraft soundtrack
+ - Playback controls
+ - Magic
+
+# New Features
+
+ - View queue
+ - Playback controls
+
+### Tech
+
+The Minecraft Soundtrack Bot uses a number of open source projects to work properly:
+
+* [@discordjs/opus] - Cool extension for Opus support
+* [at-quotes] - Epic quotes
+* [discord.js-commando] - Insane.
+* [emoji-random] - Who doesn't like emojis.
+* [ytdl-core] - Very nice.
+* [discord.js] - duh
+
+### Installation
+
+Just invite the bot to your server!
+
+### Development
+
+Contributation currently closed, sorry.
+
+### Todos
+
+ - Add more cool features :D
+
+License
+----
+
+MIT
+
+ [@discordjs/opus]: <https://www.npmjs.com/package/@discordjs/opus>
+ [at-quotes]: <https://www.npmjs.com/package/at-quotes>
+ [discord.js-commando]: <https://www.npmjs.com/package/discord.js-commando>
+ [emoji-random]: <https://www.npmjs.com/package/emoji-random>
+ [ytdl-core]: <https://www.npmjs.com/package/ytdl-core>
+
+ [discord.js]: <https://github.com/discordjs/discord.js>