diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 14 insertions, 4 deletions
@@ -1,16 +1,22 @@ # peerflix-deadbeef +**peerflix-deadbeef** is a wrapper script to use (peerflix)[https://github.com/mafintosh/peerflix] to listen to music from torrents in (DeaDBeeF)[https://github.com/DeaDBeeF-Player/deadbeef]. + ### Usage ``` peerflix-deadbeef <magnet link or torrent file> ``` -### Requirements +## Requirements + +Make sure that `peerflix` and `curl` or `wget` are in your `$PATH`. + +On Linux, `deadbeef` is expected to be in your `$PATH`. -Make sure that `peerflix` and `deadbeef` are in your `$PATH`. +On macOS, script assumes that `DeaDBeeF.app` is installed to `/Applications`. -### Install +## Install ``` git clone https://github.com/gch1p/peerflix-deadbeef @@ -18,8 +24,12 @@ cd peerflix-deadbeef sudo make install ``` -### Uninstall +## Uninstall ``` sudo make uninstall ``` + +## License + +MIT |