diff --git a/README.md b/README.md index 744384b21106c6fc64985729694ad734a345630f..53410e241553aea05dc6a7300ee7ebd150fef770 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,65 @@ WIP # Vpn-Hole -A self-contained GoLang library that is capable of blocking ads,malwares and trackers using DNS Sinkholing. This librray can be integrated with different pre-existing cross-platform applications. +A self-contained GoLang library that is capable of blocking ads,malwares and trackers using [DNS Sinkholing](https://en.wikipedia.org/wiki/DNS_sinkhole). This libray can be integrated with different pre-existing cross-platform applications. + +You can learn more about the project from the [blogs](https://leap.se/#blog) at [leap.se](https://leap.se). ## Table of Contents +* [Installation](#installation) + * [Go](#Go) + * [GoMobile](#GoMobile) + * [VPN-Hole](#VPN-Hole) +* [Instructions](#Instructions) +* [Build & Run](#Build & Run) +* [Test](#Test) +* [Integration](#Integration) +* [Adapting to Bitmask_core](#Adapting to Bitmask_core) +* [License](#License) + +## Installation <a name="installation"></a> + +### Go <a name="Go"></a> + +``` + +``` + +### GoMobile <a name="GoMobile"></a> + +``` + +``` + +## VPN-Hole <a name="VPN-Hole"></a> + +``` + +``` + +### Instructions <a name="Instructions"></a> + + +## Build & Run <a name="Build & Run"></a> + +``` +# build the library + +# executing the binary + +``` + +## Integration <a name="Integration"></a> + +``` -## License +``` -## Integration +### Adapting to Bitmask_core <a name="Adapting to Bitmask_core"></a> -### Adapt to Bitmask_core +``` -### Dependencies +``` -## Features +## License <a name="License"></a>