Skip to content

Commit 1566e78

Browse files
committed
Update README
1 parent 89b6159 commit 1566e78

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

README.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# spotify-cli-linux
22

3-
[![Build](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/build.yml)
4-
[![Deploy](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/deploy.yml/badge.svg)](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/deploy.yml)
5-
[![Version](https://img.shields.io/pypi/v/spotify-cli-linux.svg?style=flat-square)](https://pypi.python.org/pypi/spotify-cli-linux/)
3+
[![Build](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/build.yml)
4+
[![Deploy](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/deploy.yml/badge.svg)](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/deploy.yml)
5+
[![Version](https://img.shields.io/pypi/v/spotify-cli-linux.svg?style=flat-square)](https://pypi.python.org/pypi/spotify-cli-linux/)
66

77
A command line interface to [Spotify](https://www.spotify.com/) on Linux.
88

99
If you're using macOS, see [spotify-cli-macos](https://github.com/pwittchen/spotify-cli-macos).
1010

11-
installation
12-
------------
11+
## installation
1312

1413
```
1514
pip install spotify-cli-linux
@@ -27,17 +26,15 @@ cd spotify-cli-linux
2726
sudo cp spotifycli/spotifycli.py /usr/local/bin/spotifycli
2827
```
2928

30-
upgrade
31-
-------
29+
## upgrade
3230

3331
```
3432
pip install spotify-cli-linux --upgrade
3533
```
3634

3735
for the upgrade, you can apply the same hints like for installation
3836

39-
usage
40-
-----
37+
## usage
4138

4239
start the official Spotify desktop app
4340

@@ -69,15 +66,15 @@ use one of the following parameters:
6966
--playpause plays or pauses the song (toggles a state)
7067
--next plays the next song
7168
--prev plays the previous song
69+
--clear clear the terminal
7270
--songuri OPENURI plays the track at the provided Uri
7371
--listuri OPENURI plays the playlist at the provided Uri
7472
--client CLIENT sets client's dbus name
7573
```
7674

7775
if you don't use any parameters, you'll enter the shell mode, where you'll be able to use all commands mentioned above
7876

79-
solving problems
80-
----------------
77+
## solving problems
8178

8279
### lyriq
8380

@@ -87,22 +84,19 @@ When, you're missing `lyriq` dependency, run the following command:
8784
pip install lyriq
8885
```
8986

90-
usage with tmux
91-
---------------
87+
## usage with tmux
9288

9389
If you want to use this script in your tmux panel, you can check [tmux-plugin-spotify](https://github.com/pwittchen/tmux-plugin-spotify).
9490

95-
development
96-
-----------
91+
## development
9792

9893
to install necessary tools for code formatting, static code analysis and releasing, run:
9994

10095
```
10196
make requirements
10297
```
10398

104-
code formatting
105-
---------------
99+
## code formatting
106100

107101
Source code should be formatted according to [PEP8](https://www.python.org/dev/peps/pep-0008/) style guides.
108102

@@ -118,17 +112,15 @@ to verify code formatting, type:
118112
make checkformat
119113
```
120114

121-
static code analysis
122-
--------------------
115+
## static code analysis
123116

124117
To run static code analysis, execute:
125118

126119
```
127120
make lint
128121
```
129122

130-
docs
131-
----
123+
## docs
132124

133125
to update docs on `gh-pages`, type:
134126

@@ -137,6 +129,7 @@ make docs
137129
```
138130

139131
to run docs locally, type:
132+
140133
```
141134
git checkout gh-pages && ./serve.sh
142135
```
@@ -145,8 +138,7 @@ and view page with docs at: 0.0.0.0:8000
145138

146139
view it on-line at https://pwittchen.github.io/spotify-cli-linux
147140

148-
releasing
149-
---------
141+
## releasing
150142

151143
currently release is automated via `deploy.yml` GitHub Action, but it can be done manually too
152144

0 commit comments

Comments
 (0)