diff --git a/README.md b/README.md new file mode 100644 index 0000000..61b2813 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Jellyfin Discord Music Bot + +Jellyfin Discord Music Bot is a Discord Bot for the [Jellyfin Media Server!](http://github.com/jellyfin/jellyfin); + +## Getting Started + +The simplest way to get started is using Docker(repository will soon be added): + +``` +git clone https://github.com/kgt1/jellyfin-discord-music-bot.git +cd jellyfin-discord-music-bot +docker build -t YOUR_IMAGE_NAME . +``` + +``` +docker run -d \ + --name jellyfin-discord-music-bot \ + -e DISCORD_PREFIX="?" \ + -e DISCORD_TOKEN="yourtokengoeshere" \ + -e JELLYFIN_SERVER_ADDRESS="https://jellyfin.DOMAIN" \ + -e JELLYFIN_USERNAME="" \ + -e JELLYFIN_PASSWORD="" \ + -e JELLYFIN_APP_NAME="Jellyfin Discord Music Bot" \ + YOUR_IMAGE_NAME +``` \ No newline at end of file diff --git a/package.json b/package.json index 3df1bf6..258eaac 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "jellyfin-discord-music-bot", "version": "0.0.1", - "description": "A Discord Music Bot for the Jellyfin Media Server", + "description": "Jellyfin Discord Music Bot is a Discord Bot for the Jellyfin Media Server!", "main": "src/index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1",