X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README;h=d8524e29c92796045f6779a22a4f2f97304c5bf0;hb=50c93bb8f825f9796ff2cf95f321276ccde592b2;hp=f6be6fbffc81682a1d603114da9f35b3cbe10962;hpb=908161662bbe796e2962929ff2131c9bae07f13e;p=framework%2Fconnectivity%2Fconnman.git

diff --git a/README b/README
index f6be6fb..d8524e2 100644
--- a/README
+++ b/README
@@ -1,24 +1,108 @@
 Connection Manager
 ******************
 
-Copyright (C) 2007-2008  Intel Corporation. All rights reserved.
+Copyright (C) 2007-2010  Intel Corporation. All rights reserved.
+
+
+Functionality and features
+==========================
+
+The following features are built-in into Connection Manager:
+	- Generic plugin infrastructure
+	- Device and network abstraction (with basic storage support)
+	- IPv4, routing and DNS configuration
+
+Various plugins can be enabled for networking support:
+	- Ethernet plugin
+	- WiFi plugin with WEP40/WEP128 and WPA/WPA2 (personal only) support
+	- Bluetooth plugin
+
+Also plugins with additional features are available:
+	- DHCP plugin (dhclient)
+	- Resolver plugin (DNS proxy)
+	- Loopback setup
+	- PolicyKit support
 
 
 Compilation and installation
 ============================
 
-In order to compile libgdbus you need following software packages:
+In order to compile Connection Manager you need following software packages:
 	- GCC compiler
 	- GLib library
 	- D-Bus library
-	- GDBus library
-	- HAL library
-	- SQLite3 library
+	- udev library (optional)
+	- PolicyKit (optional)
 
 To configure run:
 	./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
- 
-Configure automatically searches for all required components and packages. 
+
+Configure automatically searches for all required components and packages.
 
 To compile and install run:
 	make && make install
+
+
+Configuration and options
+=========================
+
+For a working system, certain configuration options need to be enabled:
+
+	--enable-ethernet
+
+		Enable support for Ethernet network cards
+
+	--enable-wifi
+
+		Enable support for WiFi devices (requires wpa_supplicant)
+
+
+	--enable-bluetooth
+
+		Enable support for Bluetooth devices (requires BlueZ)
+
+	--enable-dhclient
+
+		Enable DHCP client support for ISC dhclient based systems
+
+		The location of the dhclient binary is auto-detected, but it
+		can be overwritten via --with-dhclient=<path-to-binary>.
+
+		At least one DHCP client option should be selected. It is
+		possible to select both and then uDHCP will be tried first
+		before falling back to dhclient.
+
+	--enable-dnsproxy
+
+		Enable DNS proxy support for /etc/resolv.conf abstraction
+
+		The best solution for multiple connections and proper DNS
+		handling is a DNS proxy server. This binds a DNS proxy
+		server to port 53 on the loopback interface (127.0.0.1).
+
+		The /etc/resolv.conf file needs a "nameserver 127.0.0.1"
+		entry, but can now set the immutable bit or be on a read-only
+		filesystem. No further modification to that file will be made.
+
+		It is important that this is not used together with other
+		DNS proxy solution like dnsmasq.
+
+	--enable-loopback
+
+		Enable setup of loopback device
+
+		For distributions with a really minimal init system and no
+		networking scripts this can take care of setting up the
+		loopback device and enabling it.
+
+		It is safe to select this option even if networking scripts
+		are in place. It detects an already configured loopback
+		device and leaves it as it is.
+
+	--enable-polkit
+
+		Enable support for PolicyKit authorization
+
+		This allows to check every D-Bus access against a security
+		policy and so restrict access to certain functionality.
+