aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf58e13
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# peerflix-deadbeef
+
+### Usage
+
+```
+peerflix-deadbeef <magnet link or torrent file>
+```
+
+### Requirements
+
+Make sure that `peerflix` and `deadbeef` are in your `$PATH`.
+
+### Install
+
+```
+git clone https://github.com/gch1p/peerflix-deadbeef
+cd peerflix-deadbeef
+sudo make install
+```
+
+### Uninstall
+
+```
+sudo make uninstall
+```