mirror of
https://github.com/cgzirim/seek-tune.git
synced 2025-12-18 17:34:22 +00:00
Update README.md
This commit is contained in:
parent
8c3bba038d
commit
80093b51d0
1 changed files with 6 additions and 6 deletions
12
README.md
12
README.md
|
|
@ -42,34 +42,34 @@ npm install
|
||||||
|
|
||||||
## Usage :bicyclist:
|
## Usage :bicyclist:
|
||||||
|
|
||||||
#### ▸ Start the Client App
|
#### ▸ Start the Client App 🏃♀️➡️
|
||||||
```
|
```
|
||||||
# Assuming you're in the client directory:
|
# Assuming you're in the client directory:
|
||||||
|
|
||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
#### ▸ Start the Backend App
|
#### ▸ Start the Backend App 🏃♀️
|
||||||
In a separate terminal window:
|
In a separate terminal window:
|
||||||
```
|
```
|
||||||
cd seek-tune
|
cd seek-tune
|
||||||
go run *.go serve [-proto <http|https> (default: http)] [-port <port number> (default: 5000)]
|
go run *.go serve [-proto <http|https> (default: http)] [-port <port number> (default: 5000)]
|
||||||
```
|
```
|
||||||
#### ▸ Download a Song
|
#### ▸ Download a Song 📥
|
||||||
Note: A link from Spotify's mobile app won't work. You can copy the link from either the desktop or web app.
|
Note: A link from Spotify's mobile app won't work. You can copy the link from either the desktop or web app.
|
||||||
```
|
```
|
||||||
go run *.go download <https://open.spotify.com/.../...>
|
go run *.go download <https://open.spotify.com/.../...>
|
||||||
```
|
```
|
||||||
#### ▸ Save local songs to DB (supports all audio formats)
|
#### ▸ Save local songs to DB (supports all audio formats) 🗃️
|
||||||
```
|
```
|
||||||
go run *.go save [-f|--force] <path_to_song_file_or_dir_of_songs>
|
go run *.go save [-f|--force] <path_to_song_file_or_dir_of_songs>
|
||||||
```
|
```
|
||||||
The `-f` or `--force` flag allows saving the song even if a YouTube ID is not found. Note that the frontend will not display matches without a YouTube ID.
|
The `-f` or `--force` flag allows saving the song even if a YouTube ID is not found. Note that the frontend will not display matches without a YouTube ID.
|
||||||
|
|
||||||
#### ▸ Find matches for a song/recording
|
#### ▸ Find matches for a song/recording 🔎
|
||||||
```
|
```
|
||||||
go run *.go find <path-to-wav-file>
|
go run *.go find <path-to-wav-file>
|
||||||
```
|
```
|
||||||
#### ▸ Delete fingerprints and songs
|
#### ▸ Delete fingerprints and songs 🗑️
|
||||||
```
|
```
|
||||||
go run *.go erase
|
go run *.go erase
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue