summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorAliaksei Maiseyeu <jetfire6@gmail.com>2019-05-24 13:17:26 +0300
committerMarc Cornellà <marc.cornella@live.com>2019-05-24 12:17:26 +0200
commitfa187791cad4447029402a236f70d98424f511ee (patch)
tree87a3d0f46d31795c87b239c1dcfb60d3d5853579 /plugins
parent60736c9f37ccf886291a5995dfc6f7215b0d8b56 (diff)
downloadzsh-fa187791cad4447029402a236f70d98424f511ee.tar.gz
zsh-fa187791cad4447029402a236f70d98424f511ee.tar.bz2
zsh-fa187791cad4447029402a236f70d98424f511ee.zip
torrent: add README (#7873)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/torrent/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/torrent/README.md b/plugins/torrent/README.md
new file mode 100644
index 000000000..079aafcb0
--- /dev/null
+++ 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.