From 4d325c0d208700db64870201b5a195ebdf320a74 Mon Sep 17 00:00:00 2001
From: Timothy <yexiaozhou2003@gmail.com>
Date: Wed, 14 May 2014 22:35:30 +0800
Subject: [PATCH] Update readme file & sample config file

---
 README.md          | 52 ++++++++++++++++++++++++++++++++++++++++++----
 config_sample.json |  2 +-
 2 files changed, 49 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index e1077f3..bfa35f3 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,50 @@
-godns
-=====
+## GoDNS
 
-[![Build Status](https://drone.io/github.com/TimothyYe/godns/status.png)](https://drone.io/github.com/TimothyYe/godns/latest)
+[![Build Status](https://travis-ci.org/TimothyYe/godns.svg?branch=master)](https://travis-ci.org/TimothyYe/godns)
 
-A dynamic DNS tool, based on dnspod, written by Golang.
+GoDNS is a dynamic DNS (DDNS) tool, it is based on my early open source project: [DynDNS](https://github.com/TimothyYe/DynDNS). 
+
+Now I rewrite [DynDNS](https://github.com/TimothyYe/DynDNS) by Golang and call it [GoDNS](https://github.com/TimothyYe/godns).
+
+## Pre-condition
+
+GoDNS is relied to [DNSPod](http://dnspod.cn) and its API. 
+
+To use GoDNS, you need to have a domain and host it on [DNSPod](http://dnspod.cn).
+
+## Build it
+
+### Get & build it from source code
+
+* Get source code from Github:
+
+```bash
+git clone https://github.com/TimothyYe/godns.git
+```
+* Go into the godns directory, get related library and then build it:
+
+```bash
+cd godns
+go get
+go build
+```
+* Then you get GoDNS.
+
+### Build godns from the 3rd party 
+
+* Visit this URL provided by [GoBuild](http://gobuild.io/download/github.com/TimothyYe/godns).
+* Select the platform you need.
+* Input the build type and branch name.
+* Build and download GoDNS.
+
+## Run it
+
+* Get [config_sample.json](https://github.com/TimothyYe/godns/blob/master/config_sample.json) from Github.
+* Rename it to **config.json**.
+* Configure your domain/sub-domain info, username and password of DNSPod account.
+* Save it in the same directory of GoDNS.
+* The last step, run godns:
+```bash
+nohup ./godns &
+```
+* Enjoy it!
diff --git a/config_sample.json b/config_sample.json
index a789814..bc40a8f 100644
--- a/config_sample.json
+++ b/config_sample.json
@@ -3,5 +3,5 @@
 	"password": "",
 	"domain": "",
 	"sub_domain": "",
-	"ip_url": ""
+	"ip_url": "http://members.3322.org/dyndns/getip"
 }
\ No newline at end of file