torrent: add README (#7873)

7 years ago · fa187791ca
parent 60736c9f37
commit fa187791ca
1 changed files with 13 additions and 0 deletions
--- a/plugins/torrent/README.md
+++ b/plugins/torrent/README.md
@ -0,0 +1,13 @@
+# torrent
+
+This plugin creates a Torrent file based on a [MagnetURI](https://en.wikipedia.org/wiki/Magnet_URI_scheme).
+
+To use it, add `torrent` to the plugins array in your zshrc file.
+
+```zsh
+plugins=(... torrent)
+```
+
+## Plugin commands
+
+* `magnet_to_torrent <MagnetURI>`: creates Torrent file.