docs: update readme and makefile

Author: potsables

Makefile

@@ -1,5 +1,4 @@
 GOCC ?= go
-IPFSVERSION=v0.4.18
 
 .PHONY: install build gx
 
@@ -52,7 +51,6 @@ import:
 	gx import github.com/ipfs/go-ipfs
 
 .PHONY: vendor
-
 vendor:
 	# Nuke vendor directory
 	rm -rf vendor
@@ -68,3 +66,7 @@ vendor:
 
 	# Remove problematic dependencies
 	find . -name test-vectors -type d -exec rm -r {} +
+
+.PHONY: ipfs
+ipfs:
+	( cd vendor/github.com/ipfs/go-ipfs/cmd/ipfs ; go build ; cp ipfs $(GOPATH)/bin)

README.md

@@ -32,14 +32,19 @@ config file is generated containing the i2p configuration and it's base32 and
 base64 addresses. This is stored in a file called "i2pconfig." Finally, it
 simply forwards the IPFS gateway to I2P.
 
-Compiling
+Installation And Setup
 ---------
 
+The gotcha to the IPFS plugin system is that you'll need to run an IPFS node, that is using the same version of IPFS which was used to build the plugin.
+Due to `gx` being extensively used by the IPFS project, and it being hard to work with, you will not be able to use it with any IPFS daemon that wasn't built from the code within the `vendor/github.com/ipfs/go-ipfs` folder of this repository. This is somewhat undesirable, but it is the only way to reliably run this plugin.  At the time of this commit, the go-ipfs commit we use is [df373ca3876ed4f706d8635c200c973f4189fcc6](https://github.com/ipfs/go-ipfs/commit/df373ca3876ed4f706d8635c200c973f4189fcc6). Over time hopefully we can imrpove this system, and make it usable with released versions of IPFS. As such, all dependencies are vendored with this repository.
+
+To build the IPFS version needed to use this plugin run `make ipfs` which will copy the built `ipfs` binary to `$GOPATH/bin`. After that, the usual IPFS setup is needed which won't be covered here.
+
 Running the deps target pulls in the dependencies, and the build target profile
 builds the plugin. Since there's no "main" function you can't "go get" the
 plugin package, you have to clone it.
 
-        git clone https://github.com/rtradeltd/go-ipfs-plugin-i2p-gateway
+        git clone https://github.com/RTradeLTd/go-ipfs-plugin-i2p-gateway
         make deps build
 
 Installing and Using it