From: Bjoern Sikora <bjoern.sikora@intra2net.com>
Date: Thu, 15 Oct 2009 15:41:23 +0000 (+0200)
Subject: Adjusted README file to this project.
X-Git-Tag: v1.1~142
X-Git-Url: http://developer.intra2net.com/git/?a=commitdiff_plain;h=4e3d408ff6c8b8b97689023de4ea22401a942dd2;p=bpdyndnsd

Adjusted README file to this project.
---

diff --git a/README b/README
index 1a96a1e..fefa7a8 100644
--- a/README
+++ b/README
@@ -1,30 +1,56 @@
 -----------------------------------------------
-Simple C++ Hello World template based on cmake
-QStart
-Author: Anne-Marie Mahfouf
-Date: 2006-12-06
+Bullet proof dynamic DNS daemon
+
+A bullet proof easy to use dynamic DNS update daemon.
+Although of the ease of use it's highly scalable and
+flexible for advanced configurations. At the moment
+it supports following protocols: DHS, DYNDNS, DYNS,
+EASYDNS, GNUDIP, ODS, TZO and ZONEEDIT. The IP address
+to update the dynamic DNS name can be determined
+either through the wan interface's IP itself or through
+a webcheck IP URL if located behind a NAT router.
+It's possible to use multiple services at the same
+time and for each configured service special parameters
+can be declared, such as the update interval, maximal
+number of updates within this interval or the DNS cache
+ttl. It's also possible to configure a HTTP proxy and
+the corresponding port. It fully supports IPv6.
+
+bpdyndnsd
+
+Author: Bjoern Sikora, Intra2net AG
+Date: 2009-10-15
 -----------------------------------------------
 
 This README file explains you basic things for starting with
-this application template.
+this application.
 
 -----------------------------------------------
 * REQUIREMENTS *
-- Qt version might be 3.3.4 or 3.3.5
--  kdelibs 3.5 and kdelibs headers 3.5 (devel package) in order to build this template.
-- cmake (http://www.cmake.org/) version 2.1 or 2.2 in your PATH
+
+- cmake >= 2.6
+- boost >= 1.37.0, boost-devel >= 1.37.0
+- libcurl >= 7.19.6, libcurl-devel >= 7.19.6
+- openssl >= 0.9.8k, openssl-devel >= 0.9.8k
 -----------------------------------------------
 
 -----------------------------------------------
 * Building and running *
-- cmake will run after the template is loaded provided cmake is in your PATH. If not, you will see an error message in the terminal
-and you will need to install cmake in your PATH.
-- In the Build menu in KDevelop, click on Build Project (or use the F8 shortcut) in order to build your project.
-- Run your project using the Build menu -> Execute Program. Note that default makes your program run in KDevelop integrated terminal. You can run your program in an external terminal by changing the project options (Project -> Project Options -> Run options and check at the bottom "Start in external terminal")
+cd build
+cmake ..
+make && make install
+cp config/bpdyndnsd.conf /etc/bpdyndnsd
+cp scripts/bpdyndnsd /etc/init.d/
+chkconfig --add bpdyndnsd
+chkconfig --level 345 bpdyndnsd on
+
+Adjust the config file to your needs and add a config file for your dynamic DNS service.
+You can start the daemon through "/etc/init.d/bpdyndnsd start" or start manually through /usr/local/bin/bpdyndnsd
+
 -----------------------------------------------
 
 -----------------------------------------------
 * Useful link *
 
-CMake Documentation: http://www.cmake.org/HTML/Documentation.html
+www.intra2net.com/developer/bpdyndnsd