aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSerpentDrago <[email protected]>2023-10-23 21:36:13 -0400
committerGitHub <[email protected]>2023-10-23 20:36:13 -0500
commitc5f8d3373baec3a09c50ae1149f7a014565c5593 (patch)
tree0fcc0951eea6f71ed8fa92e2ab9245218d89524b
parenta32530855e3dfa7c066dd14ec2ff876f8e9f3e51 (diff)
downloadmuse-c5f8d3373baec3a09c50ae1149f7a014565c5593.tar.xz
muse-c5f8d3373baec3a09c50ae1149f7a014565c5593.zip
Update README.md (#975)
Co-authored-by: Max Isom <[email protected]>
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index d474a53..394af6a 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,9 @@ Muse is written in TypeScript. You can either run Muse with Docker (recommended)
- `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` can be acquired [here](https://developer.spotify.com/dashboard/applications) with 'Create a Client ID'.
- `YOUTUBE_API_KEY` can be acquired by [creating a new project](https://console.developers.google.com) in Google's Developer Console, enabling the YouTube API, and creating an API key under credentials.
+> [!WARNING]
+> Even if you don't plan on using Spotify, you must still provide the client ID and secret; otherwise Muse will not function.
+
Muse will log a URL when run. Open this URL in a browser to invite Muse to your server. Muse will DM the server owner after it's added with setup instructions.
A 64-bit OS is required to run Muse.