From 28901b8e65cdee3f2ffae64dfac2471534da474d Mon Sep 17 00:00:00 2001
From: idk
Date: Tue, 25 Feb 2020 22:58:51 -0500
Subject: [PATCH] add torrent basic guide
---
Makefile | 8 ++++----
torrent/README.md | 30 +++++++++++++++++++++++++++++-
torrent/index.html | 29 +++++++++++++++++++++++++++++
3 files changed, 62 insertions(+), 5 deletions(-)
diff --git a/Makefile b/Makefile
index f469325..eeda03c 100644
--- a/Makefile
+++ b/Makefile
@@ -324,7 +324,7 @@ webext:
web-ext run -u "about:devtools-toolbox?type=extension&id=i2ppb%40eyedeekay.github.io"
snark-mirror:
- http_proxy=http://127.0.0.1:4444 wget -c -O i2psnark-rpc.su3 http://stats.i2p/i2p/plugins/i2psnark-rpc.su3
- gothub upload -R -u eyedeekay -r I2P-in-Private-Browsing-Mode-Firefox -t $(VERSION) -n "i2psnark-rpc.su3" -f i2psnark-rpc.su3
- http_proxy=http://127.0.0.1:4444 wget -c -O i2psnark-rpc-update.su3 http://stats.i2p/i2p/plugins/i2psnark-rpc-update.su3
- gothub upload -R -u eyedeekay -r I2P-in-Private-Browsing-Mode-Firefox -t $(VERSION) -n "i2psnark-rpc-update.su3" -f i2psnark-rpc-update.su3
\ No newline at end of file
+ http_proxy=http://127.0.0.1:4444 wget -c -O ../i2psnark-rpc.su3 http://stats.i2p/i2p/plugins/i2psnark-rpc.su3
+ gothub upload -R -u eyedeekay -r I2P-in-Private-Browsing-Mode-Firefox -t $(VERSION) -n "i2psnark-rpc.su3" -f ../i2psnark-rpc.su3
+ http_proxy=http://127.0.0.1:4444 wget -c -O ../i2psnark-rpc-update.su3 http://stats.i2p/i2p/plugins/i2psnark-rpc-update.su3
+ gothub upload -R -u eyedeekay -r I2P-in-Private-Browsing-Mode-Firefox -t $(VERSION) -n "i2psnark-rpc-update.su3" -f ../i2psnark-rpc-update.su3
\ No newline at end of file
diff --git a/torrent/README.md b/torrent/README.md
index 60e8893..23b6090 100644
--- a/torrent/README.md
+++ b/torrent/README.md
@@ -11,4 +11,32 @@ many torrent clients, including for our purposes snark-rpc and BiglyBT.
Transmitter is released under the UNLICENSE. An original copy is available at
this URL: https://github.com/myfreeweb/transmitter/blob/master/UNLICENSE
-A copy has also been included in this directory.
\ No newline at end of file
+A copy has also been included in this directory.
+
+Configuring this extension for use with Snark-RPC!
+--------------------------------------------------
+
+One of the coolest things this extension is able to do is communicate with
+a transmission-rpc enabled torrent client. Since it's an I2P focused plugin,
+the default configuration is set up for use with the I2PSnark-RPC plugin created
+by zzz. Since Snark-RPC isn't part of the main Java I2P distribution, in order
+to do this you'll have to install the plugin. You can get a copy of it from
+inside of I2P here:
+
+ * [stats.i2p main package](http://stats.i2p/i2p/plugins/i2psnark-rpc.su3)
+ * [stats.i2p update package](http://stats.i2p/i2p/plugins/i2psnark-rpc-update.su3)
+
+I also have a mirror of the package with each release of the webextension,
+reflecting the version in use in the webextension at the time of the release.
+
+To install the plugin, go to [http://127.0.0.1:7657/configplugins](http://127.0.0.1:7657/configplugins)
+and scroll down to the section of the page where it says "Installation from URL"
+and paste the following URL:
+
+```http://stats.i2p/i2p/plugins/i2psnark-rpc.su3```
+
+Click the "Install Plugin" button and you'll be ready to go. Now, open the
+extension options menu, and just click "Save." The defaults are correct for use
+with I2PSnark-RPC, but they need to be initialized by saving the settings. If
+I2PSnark-RPC becomes part of Java I2P, these defaults will be initialized when
+the plugin is installed.
diff --git a/torrent/index.html b/torrent/index.html
index 609819e..3c2acdf 100644
--- a/torrent/index.html
+++ b/torrent/index.html
@@ -19,5 +19,34 @@ many torrent clients, including for our purposes snark-rpc and BiglyBT.
this URL: https://github.com/myfreeweb/transmitter/blob/master/UNLICENSE
A copy has also been included in this directory.
+
+Configuring this extension for use with Snark-RPC!
+
+One of the coolest things this extension is able to do is communicate with
+a transmission-rpc enabled torrent client. Since it's an I2P focused plugin,
+the default configuration is set up for use with the I2PSnark-RPC plugin created
+by zzz. Since Snark-RPC isn't part of the main Java I2P distribution, in order
+to do this you'll have to install the plugin. You can get a copy of it from
+inside of I2P here:
+
+
+
+I also have a mirror of the package with each release of the webextension,
+reflecting the version in use in the webextension at the time of the release.
+
+To install the plugin, go to http://127.0.0.1:7657/configplugins
+and scroll down to the section of the page where it says "Installation from URL"
+and paste the following URL:
+
+http://stats.i2p/i2p/plugins/i2psnark-rpc.su3
+
+Click the "Install Plugin" button and you'll be ready to go. Now, open the
+extension options menu, and just click "Save." The defaults are correct for use
+with I2PSnark-RPC, but they need to be initialized by saving the settings. If
+I2PSnark-RPC becomes part of Java I2P, these defaults will be initialized when
+the plugin is installed.