Skip to content

Commit

Permalink
update readme and run
Browse files Browse the repository at this point in the history
  • Loading branch information
Leaves333 committed Dec 11, 2024
1 parent 3a22a37 commit fa9d4d3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,43 @@

A blazing fast CLI tool for Spotify, built using Rust

Created by Surya Bhamidi, Anirudh Konidala, Canchen Li (canchen4)
Created by Surya Bhamidi (suryab2), Anirudh Konidala (ak123), Canchen Li
(canchen4)

## Motivation

- CLI's are cool
- Spotify doesn't have an official CLI alternative

## Functionality

- list the current playing song and upcoming song in queue
- follow and unfollow artists
- query information about playlists
- create and delete playlists
- add and remove songs from playlists
- follow and unfollow other artists
- rename playlists and update playlist description

## Technical Overview

**external crates:**
- uses the `rspotify` crate to interact with the Spotify API
- uses the `clap` crate to help with parsing command line arguments

**program structure:**
- `src/main.rs` contains the main program
- other files in `src/` contains the functionality for different subcommands

## Challenges

- all the useful Spotify API endpoints (playing songs, adding to queue, etc.)
need a premium account
- our Spotify for Developers program is in Development mode, which means that
only up to 25 preselected accounts can use the application. In order to allow
everybody to use our tool, we need to apply for an Extension Request with
Spotify. As a result, you probably can't use this CLI tool :(

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details
5 changes: 5 additions & 0 deletions run.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ Those who wish to build the `spotify-cli` tool from source can follow the instru
cargo run
```

> [!NOTE]
> This CLI program only works with specific Spotify accounts. You can login
> to a testing account with the following credentials:
> `Email="[email protected]"`, `password="samplepass!"`
### macOS

For macOS users, the `spotify-cli` tool can be easily installed using [Homebrew](https://brew.sh/)
Expand Down

0 comments on commit fa9d4d3

Please sign in to comment.