Version 1.0v1.0

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cce99c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+goupx - Fix golang executables to work with upx
+-------------------------------------------
+
+Installation: `go get github.com/pwaller/goupx`
+
+(or if you don't want to do it with root, `GOPATH=${PWD}/env go get github.com/pwaller/goupx` will install it to `${PWD}/env/bin/goupx`)
+
+Usage: `goupx [filename]`
+
+Fixes the `PT_LOAD` offset of [filename] and then runs `upx`.
+
+Based on [code found on the upx bugtracker](http://sourceforge.net/tracker/?func=detail&atid=102331&aid=3408066&group_id=2331).
+
+GPLv3 licensed.
+
+Fixes the following issue
+=========================
+
+    $ upx [go binary]
+                           Ultimate Packer for eXecutables
+                              Copyright (C) 1996 - 2011
+    UPX 3.08        Markus Oberhumer, Laszlo Molnar & John Reiser   Dec 12th 2011
+
+            File size         Ratio      Format      Name
+       --------------------   ------   -----------   -----------
+    upx: goupx: EOFException: premature end of file                                
+
+    Packed 1 file: 0 ok, 1 error.
+
+Typical compression ratio
+=========================
+
+Resulting filesizes are typically 25% of the original go executable. Your mileage my vary.