Skip to content

Commit 79c5a6b

Browse files
committed
update readme
1 parent afc8b17 commit 79c5a6b

File tree

4 files changed

+34
-11
lines changed

4 files changed

+34
-11
lines changed

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1-
# Yet Another Spotify Command Line Lyrics
1+
Yet Another Spotify Command Line Lyrics
2+
==========================================
3+
4+
![Lyrics-Screenshot](https://github.com/goktug97/yet-another-spotify-lyrics/blob/master/screenshot.jpg)
25

36
## Requirements
47
* ueberzug
5-
* python-dbus
6-
* request
8+
* dbus-python
9+
* requests
710
* beautifulsoup4
811
* lxml
912

10-
## Screenshot
11-
12-
![Lyrics-Screenshot](https://github.com/goktug97/yet-another-spotify-lyrics/blob/master/lyrics-screenshot.jpg)
13-
1413
## Install
1514

15+
### From PyPI
16+
```bash
17+
pip3 install yet-another-spotify-lyrics --user
18+
```
19+
20+
### From Source
1621
```bash
1722
git clone https://github.com/goktug97/yet-another-spotify-lyrics
1823
cd yet-another-spotify-lyrics
19-
python setup.py install
24+
python setup.py install --user
2025
```
2126

2227
## Usage
@@ -25,10 +30,28 @@ python setup.py install
2530
spotify-lyrics
2631
```
2732

28-
## example i3 settings for the script
33+
### Keybindings
34+
35+
| Action | Keybinding |
36+
|:-------------:|:------------:|
37+
| scrool-up | <kbd>k</kbd> |
38+
| scrool-down | <kbd>j</kbd> |
39+
| edit-lyrics | <kbd>e</kbd> |
40+
| refresh | <kbd>r</kbd> |
41+
| delete-cached | <kbd>d</kbd> |
42+
| quit-program | <kbd>q</kbd> |
43+
44+
- edit-lyrics: Open lyrics in `$EDITOR`
45+
- refresh: Re-prints lyrics and song info.
46+
- delete-cached: Deletes cached lyrics and gets lyrics from the internet.
47+
48+
### Example Use Case (i3wm)
2949
```i3
3050
bindsym $mod+Shift+Home exec st -n Lyrics -e spotify-lyrics
3151
for_window [instance="Lyrics"] floating enable; [instance="Lyrics"] move position center
3252
for_window [instance="Lyrics"] resize set 644 388
3353
```
3454

55+
## License
56+
yet-another-spotify-lyrics is licensed under the MIT License.
57+

lyrics-screenshot.jpg

-485 KB
Binary file not shown.

screenshot.jpg

186 KB
Loading

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
long_description = f.read()
99

1010
setup(name='yet-another-spotify-lyrics',
11-
version='1.0.0',
11+
version='1.0.1',
1212
description='Command Line Spotify Lyrics with Album Cover',
1313
author='Göktuğ Karakaşlı',
1414
author_email='[email protected]',
@@ -17,7 +17,7 @@
1717
long_description_content_type='text/markdown',
1818
url='https://github.com/goktug97/yet-another-spotify-lyrics',
1919
download_url=(
20-
'https://github.com/goktug97/yet-another-spotify-lyrics/archive/v1.0.0.tar.gz'),
20+
'https://github.com/goktug97/yet-another-spotify-lyrics/archive/v1.0.1.tar.gz'),
2121
py_modules=[os.path.splitext(os.path.basename(path))[0]
2222
for path in ['spotify_lyrics']],
2323
entry_points={

0 commit comments

Comments
 (0)