summaryrefslogtreecommitdiffstats
path: root/python/python3-new-rtorrent/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-new-rtorrent/README')
-rw-r--r--python/python3-new-rtorrent/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/python/python3-new-rtorrent/README b/python/python3-new-rtorrent/README
new file mode 100644
index 0000000000..52cc65e1b5
--- /dev/null
+++ b/python/python3-new-rtorrent/README
@@ -0,0 +1,11 @@
+python3-new-rtorrent (A simple rTorrent interface written in Python)
+
+The xmlrpc interface to rTorrent is extremely unintuitive and has
+very little documentation, this project aims to make interfacing
+with rTorrent much easier.
+
+NOTE: This is a required dependency for another program, but it is not
+required to be functional. Rather than adding all the dependencies of
+rtorrent itself, rtorrent will not be added to REQUIRES line. If you
+need rtorrent support with this module, you will need to install
+rtorrent itself.