Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
khanhas committed Dec 9, 2018
1 parent 996162f commit 607cab7
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 <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.

## 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
```

Expand All @@ -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

0 comments on commit 607cab7

Please sign in to comment.