added README and fixed discription accordingly

This commit is contained in:
KGT1 2020-09-18 03:17:11 +02:00
parent eb3928bd02
commit 301b706f1c
2 changed files with 26 additions and 1 deletions

25
README.md Normal file
View File

@ -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
```

View File

@ -1,7 +1,7 @@
{ {
"name": "jellyfin-discord-music-bot", "name": "jellyfin-discord-music-bot",
"version": "0.0.1", "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", "main": "src/index.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",