diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..969cf7f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 KGT1 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 5e77627..08f0e7c 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,7 @@ Jellyfin Discord Music Bot is a Discord Bot for the [Jellyfin Media Server!](htt ## 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 . -``` +The simplest way to get started is using Docker: ``` docker run -d \ @@ -21,5 +15,11 @@ docker run -d \ -e JELLYFIN_USERNAME="" \ -e JELLYFIN_PASSWORD="" \ -e JELLYFIN_APP_NAME="Jellyfin Discord Music Bot" \ - YOUR_IMAGE_NAME -``` \ No newline at end of file + kgt1/jellyfin-discord-music-bot +``` +## How to build +``` +git clone https://github.com/kgt1/jellyfin-discord-music-bot.git +cd jellyfin-discord-music-bot +docker build -t YOUR_IMAGE_NAME . +```