aboutsummaryrefslogtreecommitdiff
path: root/plugin/torrent/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/torrent/README.md')
-rw-r--r--plugin/torrent/README.md48
1 files changed, 0 insertions, 48 deletions
diff --git a/plugin/torrent/README.md b/plugin/torrent/README.md
deleted file mode 100644
index 1cc273c41..000000000
--- a/plugin/torrent/README.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# torrent
-
-## Name
-
-*torrent* - use BitTorrent to disseminate zone data.
-
-## Description
-
-The *torrent* plugin uses the BitTorrent protocol to disseminate zone data. Multiple peers can
-connect and down- and upload the data. A couple of nodes can be `seed` only meaning they will update
-the torrent when their zone data changes. Non-`seed` peers will write received data back into the
-zonefile - once the torrent is fully downloaded.
-
-## Syntax
-
-The simplest syntax is for a peer wanting to receive the zone data:
-
-~~~ txt
-torrent DBFILE
-~~~
-
-* **DBFILE** the zone database file to torrent. If the path is relative, the path from the
- *root* plugin will be prepended to it.
-
-For peers seeding the torrent use this, slightly expanded, syntax
-
-~~~ txt
-torrent DBFILE {
- dht
-// directory (temp storage)
-// port for dth, etc.
-}
-~~~
-
-* `dth` starts a DTH server on address
-
-## Examples
-
-~~~ txt
-example.org {
- file db.example.org
- torrent db.example.org
-}
-~~~
-
-## Also See
-
-## Bugs