Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
goktug97 committed Dec 19, 2019
1 parent afc8b17 commit 79c5a6b
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 11 deletions.
41 changes: 32 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
# Yet Another Spotify Command Line Lyrics
Yet Another Spotify Command Line Lyrics
==========================================

![Lyrics-Screenshot](https://github.com/goktug97/yet-another-spotify-lyrics/blob/master/screenshot.jpg)

## Requirements
* ueberzug
* python-dbus
* request
* dbus-python
* requests
* beautifulsoup4
* lxml

## Screenshot

![Lyrics-Screenshot](https://github.com/goktug97/yet-another-spotify-lyrics/blob/master/lyrics-screenshot.jpg)

## Install

### From PyPI
```bash
pip3 install yet-another-spotify-lyrics --user
```

### From Source
```bash
git clone https://github.com/goktug97/yet-another-spotify-lyrics
cd yet-another-spotify-lyrics
python setup.py install
python setup.py install --user
```

## Usage
Expand All @@ -25,10 +30,28 @@ python setup.py install
spotify-lyrics
```

## example i3 settings for the script
### Keybindings

| Action | Keybinding |
|:-------------:|:------------:|
| scrool-up | <kbd>k</kbd> |
| scrool-down | <kbd>j</kbd> |
| edit-lyrics | <kbd>e</kbd> |
| refresh | <kbd>r</kbd> |
| delete-cached | <kbd>d</kbd> |
| quit-program | <kbd>q</kbd> |

- edit-lyrics: Open lyrics in `$EDITOR`
- refresh: Re-prints lyrics and song info.
- delete-cached: Deletes cached lyrics and gets lyrics from the internet.

### Example Use Case (i3wm)
```i3
bindsym $mod+Shift+Home exec st -n Lyrics -e spotify-lyrics
for_window [instance="Lyrics"] floating enable; [instance="Lyrics"] move position center
for_window [instance="Lyrics"] resize set 644 388
```

## License
yet-another-spotify-lyrics is licensed under the MIT License.

Binary file removed lyrics-screenshot.jpg
Binary file not shown.
Binary file added screenshot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
long_description = f.read()

setup(name='yet-another-spotify-lyrics',
version='1.0.0',
version='1.0.1',
description='Command Line Spotify Lyrics with Album Cover',
author='Göktuğ Karakaşlı',
author_email='karakasligk@gmail.com',
Expand All @@ -17,7 +17,7 @@
long_description_content_type='text/markdown',
url='https://github.com/goktug97/yet-another-spotify-lyrics',
download_url=(
'https://github.com/goktug97/yet-another-spotify-lyrics/archive/v1.0.0.tar.gz'),
'https://github.com/goktug97/yet-another-spotify-lyrics/archive/v1.0.1.tar.gz'),
py_modules=[os.path.splitext(os.path.basename(path))[0]
for path in ['spotify_lyrics']],
entry_points={
Expand Down

0 comments on commit 79c5a6b

Please sign in to comment.