Skip to content

Commit 607cab7

Browse files
committed
Update README.md
1 parent 996162f commit 607cab7

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

README.md

+27-14
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
# spicetify-cli
2+
Commandline tool to customize Spotify client.
3+
Supports Windows, MacOS and Linux.
4+
5+
**Features:**
6+
- Change colors whole UI
7+
- Inject CSS for advanced customization
8+
- Enable some additional, hidden features
9+
- Remove bloated components to improve performance
10+
11+
![mac_demo1](https://i.imgur.com/8njve9b.png)
212

313
## Install
414
1. Download correct package for your OS: https://github.com/khanhas/spicetify-cli/releases
@@ -25,43 +35,48 @@ echo 'spicetify=~/spicetify/spicetify' >> .bashrc
2535
```
2636
so you can run `spicetify` everywhere.
2737

28-
## Usage
38+
## Basic usage
2939
Run with no command once to generate config file
3040
```bash
3141
spicetify
3242
```
3343

34-
Then:
44+
Make sure config file is created successfully and there is no error, then run:
3545
```bash
36-
spicetify backup
46+
spicetify backup apply enable-devtool
3747
```
3848

39-
Finally:
49+
From now, after changing colors in `color.ini` or CSS in `user.css`, you just need to run:
4050
```bash
41-
spicetify apply
51+
spicetify update
4252
```
43-
After changing theme colors and css, run `apply` again
53+
to update your theme.
54+
55+
In Spotify, hit <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>R</kbd>/<kbd>Command</kbd> <kbd>Shift</kbd> <kbd>R</kbd> to reload and receive visual update of your theme.
4456

4557
## Customization
46-
#### Config file
47-
Is located at:
58+
#### Config file
59+
Is located at:
4860
**Windows:** `%userprofile%\.spicetify\config.ini`
49-
**Linux and MacOS:** `~/.spicetify/config.ini`
61+
**Linux:** `~/.spicetify/config.ini`
62+
**MacOS:** `~/spicetify_data/config.ini`
5063

5164
#### Themes
5265
There are 2 places you can put your themes:
5366
1. `Themes` folder in Home directory
5467
**Windows:** `%userprofile%\.spicetify\Themes\`
55-
**Linux and MacOS:** `~/.spicetify/Themes/`
68+
**Linux** `~/.spicetify/Themes/`
69+
**MacOS:** `~/spicetify_data/Themes`
70+
5671
2. `Themes` folder in Spicetify executable directory
5772

5873
If there are 2 themes having same name, theme in Home directory is prioritized.
5974

6075
## Development
61-
### Requirements
76+
### Requirements
6277
- [Go](https://golang.org/dl/)
6378

64-
```bash
79+
```bash
6580
git clone https://github.com/khanhas/spicetify-cli
6681
```
6782

@@ -72,7 +87,5 @@ go build src/spicetify.go
7287
```
7388

7489
### Future
75-
[ ] Implement additional features
7690
[ ] SASS
77-
[ ] Watch theme files change and automatically apply
7891
[ ] Inject extensions and custom apps

0 commit comments

Comments
 (0)