Browse Source

torrent: add README (#7873)

Aliaksei Maiseyeu 4 years ago
parent
commit
fa187791ca
1 changed files with 13 additions and 0 deletions
  1. 13 0
      plugins/torrent/README.md

+ 13 - 0
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.