From db3da5951f2b9e648caf2179a4b7cb06ccdeaa87 Mon Sep 17 00:00:00 2001
From: zhengbaoyang <zhengb@listome.com>
Date: Wed, 15 Jun 2016 15:11:30 +0800
Subject: [PATCH] add readme

---
 readme.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..71901e7
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,66 @@
+# gomimtproxy
+
+gomitmproxy是想用golang语言实现的[mitmproxy](https://mitmproxy.org/)，主要实现http代理，目前只实现了http代理和http抓包功能，差距甚远，加油。
+
+## 可以用来干嘛？
+
+* http代理
+* http抓包
+* 科学上网
+
+## 安装使用
+
+
+```bash
+git clone https://github.com/sheepbao/gomitmproxy.git
+cd gomitmproxy 
+go build 
+```
+
+
+## 例子
+
+* http代理
+
+```bash
+gomimtproxy 
+```
+不带任何参数，表示http代理，默认端口8080
+
+更改端口用 -port 
+
+* http抓包
+
+```bash
+gomimtproxy -m 
+```
+
+加-m参数，表示抓取http请求和响应
+
+* http代理科学上网
+
+首先你得有个墙外的服务器，如阿里香港的服务器，为图中的Server，假设其ip地址为：22.222.222.222
+
+在Server执行
+
+```bash
+gomitmproxy -port 8888
+```
+
+在你自己电脑执行
+
+```bash
+gomitmproxy -port 8080 -raddr 22.222.222.222:8888
+```
+
+然后浏览器设置代理，ip为localhost，端口为8080
+
+即可实现科学上网
+
+![proxy](https://raw.githubusercontent.com/sheepbao/gomitmproxy/master/proxy.png) 
+
+
+## License
+
+The 3-clause BSD License  
+- see LICENSE for more details