diff --git a/README.md b/README.md index 479b7bf..f67cb06 100644 --- a/README.md +++ b/README.md @@ -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 @@ -25,10 +30,28 @@ python setup.py install spotify-lyrics ``` -## example i3 settings for the script +### Keybindings + +| Action | Keybinding | +|:-------------:|:------------:| +| scrool-up | k | +| scrool-down | j | +| edit-lyrics | e | +| refresh | r | +| delete-cached | d | +| quit-program | q | + +- 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. + diff --git a/lyrics-screenshot.jpg b/lyrics-screenshot.jpg deleted file mode 100644 index c295758..0000000 Binary files a/lyrics-screenshot.jpg and /dev/null differ diff --git a/screenshot.jpg b/screenshot.jpg new file mode 100644 index 0000000..e4a7872 Binary files /dev/null and b/screenshot.jpg differ diff --git a/setup.py b/setup.py index 6e192a2..365cdf4 100644 --- a/setup.py +++ b/setup.py @@ -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', @@ -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={