diff --git a/README.md b/README.md index f3dab4e..7a70412 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,14 @@ # Swing music -Swing Music is a beautiful, self-hosted music player for your local audio files. Like a cooler Spotify ... but bring -your own music. Just run the app and -enjoy your music library in a web browser. +Swing Music is a beautiful, self-hosted music player for your local audio files. Like a cooler Spotify ... but bring your own music. Just run the app and enjoy your music library in a web browser. Buy Me A Coffee -| ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/readme-artist.webp) | ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/readme-album.webp) | -|----------------------------------------------------------------------|----------------------------------------------------------------------| -| ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/readme-playlist.webp) | ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/readme-playlist.webp) | - -### For more screenshots, see the [screenshots page on the website](https://swingmusic.vercel.app/screenshots.html). +| ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/artist.webp) | ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/album.webp) | +| ------------------------------------------------------------ | ----------------------------------------------------------- | +| ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/artist2.webp) | ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/album2.webp) | +For full size screenshots, visit the [website](https://swingmusic.vercel.app). ### Setup @@ -34,57 +31,18 @@ Usage: swingmusic [options] ### Options -| Flags | Description | -|--------------------------|--------------------------------------------------------------------------------------------------------------------| -| --help, -h | Show this help message | -| --version, -v | Show the app version | -| --host | Set the host | -| --port | Set the port | -| --config | Set the config path | -| --show-feat, -sf | Do not extract featured artists from the song title | -| --show-prod, -sp | Do not hide producers in the song title | -| --no-clean-albums, -nca | Don't clean album titles. Cleaning is done by removing information in parentheses and showing it separately | -| --no-clean-tracks,-nct | Don't remove remaster information from track titles | -| --no-periodic-scan, -nps | Disable periodic scan | -| --scan-interval, -psi | Set the periodic scan interval in seconds. Default is 300 seconds (5 minutes) | -| | | -| --build | Build the application (in development) | +| Option | Short | Description | +| -------------------- | ------ | ----------------------------------------------------------------------------- | +| `--help` | `-h` | Show help message | +| `--version` | `-v` | Show the app version | +| `--host` | | Set the host | +| `--port` | | Set the port | +| `--config` | | Set the config path | +| `--no-periodic-scan` | `-nps` | Disable periodic scan | +| `--scan-interval` | `-psi` | Set the periodic scan interval in seconds. Default is 300 seconds (5 minutes) | +| `--build` | | Build the application (in development) | -| Option | Short | Description | -|--------------------------|-------|-------------------------------------------------------| -| `--help` | `-h` | Show help message | -| `--version` | `-v` | Show the app version | -| `--host` | | Set the host | -| `--port` | | Set the port | -| `--config` | | Set the config path | -| `--no-periodic-scan`| `-nps` | Disable periodic scan | -| `--scan-interval` | `-psi` | Set the periodic scan interval in seconds. Default is 300 seconds (5 minutes) | -| `--build` | | Build the application (in development) | - - -``` -╭────────────────────┬─────────┬───────────────────────────────────────────────────────────────────────────────╮ -│ Option │ Short │ Description │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --help │ -h │ Show this help message │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --version │ -v │ Show the app version │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --host │ │ Set the host │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --port │ │ Set the port │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --config │ │ Set the config path │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --no-periodic-scan │ -nps │ Disable periodic scan │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --scan-interval │ -psi │ Set the periodic scan interval in seconds. Default is 300 seconds (5 minutes) │ -├────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────┤ -│ --build │ │ Build the application (in development) │ -╰────────────────────┴─────────┴───────────────────────────────────────────────────────────────────────────────╯ - -``` To stream your music across your local network, use the `--host` flag to run the app in all ports. Like this: @@ -142,7 +100,7 @@ by a colon and indicate `:` respectively. For example, `-p 8 inside the container to be accessible from the host's IP on port `8080` outside the container. | Parameter | Function | -|:------------:|----------------------------------------------------------------------------------------------| +| :----------: | -------------------------------------------------------------------------------------------- | | `-p 1970` | WebUI | | `-v /music` | Recommended directory to store your music collection. You can bind other folder if you wish. | | `-v /config` | Configuration files. | diff --git a/screenshots/README.md b/screenshots/README.md deleted file mode 100644 index 350a977..0000000 --- a/screenshots/README.md +++ /dev/null @@ -1,12 +0,0 @@ -### Open the following links in new tabs (`ctrl + click`) to view screenshots: -> These images were taken on v1.10, they might be a lil bit outdated. -1. [Album page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/album-page.png?raw=true) -2. [Artist page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/artist-page-1.png?raw=true) -3. [Artist page continuation](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/artist-page-2.png?raw=true) -4. [Artist discography](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/artist-discography-page.png?raw=true) -5. [Folder page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/folder-page.png?raw=true) -6. [Favorite page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/favorites-page.png?raw=true) -7. [Playlist page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/playlist-page.png?raw=true) -8. [Queue page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/queue-page.png?raw=true) -9. [Search page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/search-page.png?raw=true) -10. [Settings page](https://github.com/geoffrey45/swingmusic/blob/master/screenshots/settings-page.png?raw=true) diff --git a/screenshots/album-page.png b/screenshots/album-page.png deleted file mode 100644 index f48d4eb..0000000 Binary files a/screenshots/album-page.png and /dev/null differ diff --git a/screenshots/album.webp b/screenshots/album.webp new file mode 100644 index 0000000..bf87d3b Binary files /dev/null and b/screenshots/album.webp differ diff --git a/screenshots/album2.webp b/screenshots/album2.webp new file mode 100644 index 0000000..f2367e5 Binary files /dev/null and b/screenshots/album2.webp differ diff --git a/screenshots/artist-discography-page.png b/screenshots/artist-discography-page.png deleted file mode 100644 index 59ff9ad..0000000 Binary files a/screenshots/artist-discography-page.png and /dev/null differ diff --git a/screenshots/artist-page-1.png b/screenshots/artist-page-1.png deleted file mode 100644 index ed2e739..0000000 Binary files a/screenshots/artist-page-1.png and /dev/null differ diff --git a/screenshots/artist-page-2.png b/screenshots/artist-page-2.png deleted file mode 100644 index fc31c1f..0000000 Binary files a/screenshots/artist-page-2.png and /dev/null differ diff --git a/screenshots/artist.webp b/screenshots/artist.webp new file mode 100644 index 0000000..e68ed58 Binary files /dev/null and b/screenshots/artist.webp differ diff --git a/screenshots/artist2.webp b/screenshots/artist2.webp new file mode 100644 index 0000000..b048e6a Binary files /dev/null and b/screenshots/artist2.webp differ diff --git a/screenshots/favorites-page.png b/screenshots/favorites-page.png deleted file mode 100644 index 29770f5..0000000 Binary files a/screenshots/favorites-page.png and /dev/null differ diff --git a/screenshots/folder-page.png b/screenshots/folder-page.png deleted file mode 100644 index 764dcdd..0000000 Binary files a/screenshots/folder-page.png and /dev/null differ diff --git a/screenshots/playlist-page.png b/screenshots/playlist-page.png deleted file mode 100644 index e3347b8..0000000 Binary files a/screenshots/playlist-page.png and /dev/null differ diff --git a/screenshots/queue-page.png b/screenshots/queue-page.png deleted file mode 100644 index 569e645..0000000 Binary files a/screenshots/queue-page.png and /dev/null differ diff --git a/screenshots/readme-album.webp b/screenshots/readme-album.webp deleted file mode 100644 index 5145922..0000000 Binary files a/screenshots/readme-album.webp and /dev/null differ diff --git a/screenshots/readme-artist.webp b/screenshots/readme-artist.webp deleted file mode 100644 index 4efaa05..0000000 Binary files a/screenshots/readme-artist.webp and /dev/null differ diff --git a/screenshots/readme-playlist.webp b/screenshots/readme-playlist.webp deleted file mode 100644 index 7d1822f..0000000 Binary files a/screenshots/readme-playlist.webp and /dev/null differ diff --git a/screenshots/search-page.png b/screenshots/search-page.png deleted file mode 100644 index 2b83671..0000000 Binary files a/screenshots/search-page.png and /dev/null differ diff --git a/screenshots/settings-page.png b/screenshots/settings-page.png deleted file mode 100644 index bc1c034..0000000 Binary files a/screenshots/settings-page.png and /dev/null differ