Update Readme
This commit is contained in:
20
README.md
20
README.md
@@ -1,4 +1,10 @@
|
||||
# Jellyfin-Discord
|
||||
# Jellycord
|
||||
|
||||

|
||||
|
||||
[](https://discord.gg/BkmEarDQxq)
|
||||

|
||||
|
||||
Allow the creation and management of Jellyfin users via Discord
|
||||
|
||||
Join my [Discord](https://discord.com/invite/zJMUNCPtPy) for help, and keeping an eye out for updates!
|
||||
@@ -7,7 +13,7 @@ This is a very simple and lightweight Jellyfin Discord bot for managing users. I
|
||||
|
||||
Fill out values in the .env and you're good to go!
|
||||
|
||||
# Features
|
||||
## Features
|
||||
|
||||
- Automatic Account Cleanup
|
||||
- Creating Accounts
|
||||
@@ -18,25 +24,25 @@ Fill out values in the .env and you're good to go!
|
||||
- Change bot prefix live
|
||||
- Checks for new releases
|
||||
|
||||
# Command Overview
|
||||
## Command Overview
|
||||
|
||||
**Pinging the bot will show you the necessary commands to create your account.**
|
||||
|
||||
**PLEASE NOTE BEFORE USING. THIS BOT IS MEANT TO USE REQUIRED ROLES IN ORDER TO WHITELIST USERS FOR JELLYFIN. TAKING A USERS ROLE AWAY WILL DELETE THEIR JELLYFIN ACCOUNT WHEN THE BOT RUNS ITS CLEANUP (24 Hour Schedule or Admin Forced)**
|
||||
|
||||

|
||||

|
||||
|
||||
**There are protections in place to stop users from creating an account where people can see. If a user sends the account creation or reset in a guild, the bot will delete it.**
|
||||
|
||||

|
||||

|
||||
|
||||
**If a user already has a linked Jellyfin account, the bot will not allow them to create another account.**
|
||||
|
||||

|
||||

|
||||
|
||||
**In order to create an account, you must have the required roles specified in the .env**
|
||||
|
||||

|
||||

|
||||
|
||||
***User Commands***
|
||||
- `!createaccount` <username> <password> - Create your Jellyfin account
|
||||
|
||||
Reference in New Issue
Block a user