From b346f83186ef7606481484c6d461160f51e9d03a Mon Sep 17 00:00:00 2001
From: Vladislav Yarmak <vladislav@vm-0.com>
Date: Tue, 19 May 2020 22:59:46 +0300
Subject: [PATCH] add initial doc

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f232e08..7a2b54c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
-# dumbproxy
-Dumbiest HTTP proxy ever
+dumbproxy
+=========
+
+Dumbiest HTTP proxy ever.
+
+## Features
+
+* Cross-platform (Windows/Mac OS/Linux/Android (via shell)/\*BSD)
+* Zero-configuration
+* Supports CONNECT method and forwarding of HTTPS connections
+
+## Installation
+
+#### Binary download
+
+Pre-built binaries available on [releases](https://github.com/Snawoot/dumbproxy/releases/latest) page.
+
+#### From source
+
+Alternatively, you may install dumbproxy from source. Run within source directory
+
+```
+go install
+```
+
+## Usage
+
+Just run program and it'll start accepting connections on port 8080 (default)
+
+## Synopsis
+
+```
+$ ~/go/bin/dumbproxy -h
+  -bind-address string
+    	HTTP proxy listen address (default ":8080")
+  -timeout duration
+    	timeout for network operations (default 10s)
+  -verbosity int
+    	logging verbosity (10 - debug, 20 - info, 30 - warning, 40 - error, 50 - critical) (default 20)
+```