From 0e42f3c4ee16bac2d8a63cd95034fb4b570a4f38 Mon Sep 17 00:00:00 2001
From: Evgeny Zinoviev <me@ch1p.io>
Date: Wed, 28 Jul 2021 19:32:49 +0300
Subject: add README

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index c1b7914..e95ec9b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
 # captive-netns-helper
 
+This is a program for Linux that helps you bypass VPN rules in routing table and
+custom system DNS resolver and access internet directly via physical interface.
+It was written for accessing Wi-Fi captive portals. It comes with a wrapper script
+to be easier to use.
+
+Read more [here](https://ch1p.io/gentoo-wireguard-custom-resolver-captive-portal/).
+
+## Installation
+
+```
+git clone https://github.com/gch1p/captive-netns-helper
+cd captive-netns-helper
+mkdir build
+cd build
+cmake ..
+make -j4
+sudo make install
+```
+
+## Usage
+```
+captive-portal.sh PROGRAM [ARGUMENTS]
+```
+
+For example:
+```
+captive-portal.sh curl -v https://captive.apple.com
+```
+
+## License
+
+MIT
\ No newline at end of file
-- 
cgit v1.2.3