diff --git a/README.md b/README.md index fa48893c..6a0a4748 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,36 @@ opendig ======= -Command-line tool for Open Name System (like dig is for DNS) +### Table of Contents +[Overview](#overview) +[Installation](#installation) +[Command Line Usage](#cli) +[Python Package Usage](#pythonpackage) +[Configuration](#configuration) -Installation -======= + +## Overview + +opendig is the equivalent of dig for the Open Name System, which extends DNS by supporting the registration and resolution of: + +1. user handles on the blockchain (deployed) +1. domains on the blockchain (design phase) + +#### ONS = ICANN DNS + blockchain handles + blockchain domains + +ONS is 100% backwards compatible with ICANN DNS and simply extends the functionality. + +Likewise, opendig has 100% of the functionality of dig. + + +## Installation ``` $ sudo pip install opendig ``` -Command-line Usage -======= + +## Command-line Usage ``` $ opendig -u naval @@ -19,8 +38,9 @@ $ opendig bitcoin -u naval $ opendig -d startupboy.com ``` -Python Package Usage -======= + +## Python Package Usage + ``` from opendig import ons_resolver print ons_resolver('naval') @@ -29,8 +49,8 @@ from opendig import dns_resolver print dns_resolver('startupboy.com') ``` -Configuration -======= + +## Configuration OpenDig comes with pre-configured default servers 8.8.8.8 (public DNS server by Google) and 162.243.253.65 (public ONS server by OneName). We *strongly* recommend using a local config file, and using servers of your own choice: