Skip to content

Commit

Permalink
Merge pull request #1139 from sofushn/patch-1
Browse files Browse the repository at this point in the history
remove requirement for Spotify in readme
  • Loading branch information
Codixer authored Nov 6, 2024
2 parents 716d6d9 + 32cd0f3 commit 6ec6bb8
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,9 @@ Muse is a **highly-opinionated midwestern self-hosted** Discord music bot **that
Muse is written in TypeScript. You can either run Muse with Docker (recommended) or directly with Node.js. Both methods require API keys passed in as environment variables:

- `DISCORD_TOKEN` can be acquired [here](https://discordapp.com/developers/applications) by creating a 'New Application', then going to 'Bot'.
- `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` can be acquired [here](https://developer.spotify.com/dashboard/applications) with 'Create a Client ID'.
- `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` can be acquired [here](https://developer.spotify.com/dashboard/applications) with 'Create a Client ID' (Optional).
- `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.
Expand Down Expand Up @@ -68,8 +65,6 @@ You can also store your tokens in an environment file and make it available to y
**Docker Compose**:

```yaml
version: '3.4'

services:
muse:
image: ghcr.io/museofficial/muse:latest
Expand Down

0 comments on commit 6ec6bb8

Please sign in to comment.