From ef1f96598ebbfad9b6d955e7d84311f37a1e9061 Mon Sep 17 00:00:00 2001 From: Martin Polden Date: Mon, 19 Nov 2012 19:11:03 +0100 Subject: [PATCH] Add README --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a3b6ae8 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +ifconfig.co: Simple IP address lookup service +============================================= + +A simple service for looking up your IP address. This is the code that powers +http://ifconfig.co + +Basic usage +=========== + # The usual suspects + $ curl ifconfig.co + 127.0.0.1 + $ wget -O - ifconfig.co + 127.0.0.1 + # BSD fetch + $ fetch -o - ifconfig.co + 127.0.0.1 + +Pass the appropriate flag (usually -4 and -6) to your tool to switch between +IPv4 and IPv6 lookup. + +Features +======== +* Easy to remember domain name +* Supports IPv4 and IPv6 +* Open source +* Fast +* Supports typical CLI tools (curl, wget and fetch) + +Why? +==== +* To scratch an itch +* An excuse to use Go for something +* Faster than ifconfig.me and has IPv6 support + +Code style +========== + $ gofmt -tabs=false -tabwidth=4