summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEvgeny Zinoviev <ch1p_@mbp2015.local>2019-12-23 00:25:40 +0300
committerEvgeny Zinoviev <ch1p_@mbp2015.local>2019-12-23 00:25:40 +0300
commitbdc3aceb927c3596132c2492416b775155ed055a (patch)
tree25aaac48d513382d13a5d43b7acf58336e902ca6 /README.md
parentf39fa95749320ea57f5bf7f7ad74d37aab5c9358 (diff)
multiple improvements + license
- use RANDOM to generate port number - support macOS - check that all required binaries are in $PATH - support wget if curl is not available - added license
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index cf58e13..f635337 100644
--- a/README.md
+++ b/README.md
@@ -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