diff --git a/README.md b/README.md index d90390ffd0..57af000bce 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ # spicetify-cli +Commandline tool to customize Spotify client. +Supports Windows, MacOS and Linux. + +**Features:** +- Change colors whole UI +- Inject CSS for advanced customization +- Enable some additional, hidden features +- Remove bloated components to improve performance + +![mac_demo1](https://i.imgur.com/8njve9b.png) ## Install 1. Download correct package for your OS: https://github.com/khanhas/spicetify-cli/releases @@ -25,43 +35,48 @@ echo 'spicetify=~/spicetify/spicetify' >> .bashrc ``` so you can run `spicetify` everywhere. -## Usage +## Basic usage Run with no command once to generate config file ```bash spicetify ``` -Then: +Make sure config file is created successfully and there is no error, then run: ```bash -spicetify backup +spicetify backup apply enable-devtool ``` -Finally: +From now, after changing colors in `color.ini` or CSS in `user.css`, you just need to run: ```bash -spicetify apply +spicetify update ``` -After changing theme colors and css, run `apply` again +to update your theme. + +In Spotify, hit Ctrl Shift R/Command Shift R to reload and receive visual update of your theme. ## Customization -#### Config file -Is located at: +#### Config file +Is located at: **Windows:** `%userprofile%\.spicetify\config.ini` -**Linux and MacOS:** `~/.spicetify/config.ini` +**Linux:** `~/.spicetify/config.ini` +**MacOS:** `~/spicetify_data/config.ini` #### Themes There are 2 places you can put your themes: 1. `Themes` folder in Home directory **Windows:** `%userprofile%\.spicetify\Themes\` -**Linux and MacOS:** `~/.spicetify/Themes/` +**Linux** `~/.spicetify/Themes/` +**MacOS:** `~/spicetify_data/Themes` + 2. `Themes` folder in Spicetify executable directory If there are 2 themes having same name, theme in Home directory is prioritized. ## Development -### Requirements +### Requirements - [Go](https://golang.org/dl/) -```bash +```bash git clone https://github.com/khanhas/spicetify-cli ``` @@ -72,7 +87,5 @@ go build src/spicetify.go ``` ### Future -[ ] Implement additional features [ ] SASS -[ ] Watch theme files change and automatically apply [ ] Inject extensions and custom apps