Add README

This commit is contained in:
Martin Polden 2012-11-19 19:11:03 +01:00
commit ef1f96598e
1 changed files with 37 additions and 0 deletions

37
README.md Normal file
View File

@ -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