update readme
mungai-njoroge
74
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.
|
||||
|
||||
<a href="https://www.buymeacoffee.com/mungai/membership" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
|
||||
|
||||
|  |  |
|
||||
|----------------------------------------------------------------------|----------------------------------------------------------------------|
|
||||
|  |  |
|
||||
|
||||
### For more screenshots, see the [screenshots page on the website](https://swingmusic.vercel.app/screenshots.html).
|
||||
|  |  |
|
||||
| ------------------------------------------------------------ | ----------------------------------------------------------- |
|
||||
|  |  |
|
||||
|
||||
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 `<external>:<internal>` 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. |
|
||||
|
||||
@ -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)
|
||||
|
Before Width: | Height: | Size: 658 KiB |
BIN
screenshots/album.webp
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
screenshots/album2.webp
Normal file
|
After Width: | Height: | Size: 199 KiB |
|
Before Width: | Height: | Size: 1.1 MiB |
|
Before Width: | Height: | Size: 749 KiB |
|
Before Width: | Height: | Size: 913 KiB |
BIN
screenshots/artist.webp
Normal file
|
After Width: | Height: | Size: 124 KiB |
BIN
screenshots/artist2.webp
Normal file
|
After Width: | Height: | Size: 160 KiB |
|
Before Width: | Height: | Size: 706 KiB |
|
Before Width: | Height: | Size: 428 KiB |
|
Before Width: | Height: | Size: 694 KiB |
|
Before Width: | Height: | Size: 454 KiB |
|
Before Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 939 KiB |
|
Before Width: | Height: | Size: 338 KiB |