From 3af7505c51b5a5f0dbf3087f6938b98cdcbb6403 Mon Sep 17 00:00:00 2001 From: Simon Hamilton Date: Fri, 29 Apr 2011 19:57:43 +0100 Subject: [PATCH] Tidy up the readme --- README.mdown | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.mdown b/README.mdown index fec8002..fd8c8e0 100644 --- a/README.mdown +++ b/README.mdown @@ -1,19 +1,25 @@ -# dyndnsimple +# DynDNSimple + +DynDNSimple is a ruby daemon for regularly updating a DNSimple hosted domain A Record based on your current external IP Address. ## Setup -Run bundle install -Edit the config file with your dnsimple and domain settings +You will need to have an existing A Record to modify. + +1. Run bundle install +2. Edit the config file with your DNSimple and domain settings + ## Usage - $ ruby dyndnsimple.rb start - $ ruby dyndnsimple.rb restart - $ ruby dyndnsimple.rb stop - $ ruby dyndnsimple.rb run (to run in foreground) - + $ ruby dyndnsimple.rb start + $ ruby dyndnsimple.rb restart + $ ruby dyndnsimple.rb stop + $ ruby dyndnsimple.rb run (to run in foreground) + + ## TODO -Write tests -Create a launch file for OSX -refactor \ No newline at end of file +- Write tests +- Create a launch file for OSX +- refactor