sync doc

README.md

@@ -2,9 +2,9 @@
 
 # econfig - simple Erlang config handler using INI files #
 
-Copyright (c) 2012-2013 Benoît Chesneau.
+Copyright (c) 2012-2014 Benoît Chesneau.
 
-__Version:__ 0.4.1
+__Version:__ 0.4.2
 
 # econfig
 

doc/econfig_util.md

@@ -10,7 +10,7 @@
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#abs_pathname-1">abs_pathname/1</a></td><td></td></tr><tr><td valign="top"><a href="#find_files-1">find_files/1</a></td><td></td></tr><tr><td valign="top"><a href="#find_files-2">find_files/2</a></td><td></td></tr><tr><td valign="top"><a href="#find_files-3">find_files/3</a></td><td></td></tr><tr><td valign="top"><a href="#find_ini_files-1">find_ini_files/1</a></td><td></td></tr><tr><td valign="top"><a href="#implode-2">implode/2</a></td><td></td></tr><tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#abs_pathname-1">abs_pathname/1</a></td><td></td></tr><tr><td valign="top"><a href="#find_files-1">find_files/1</a></td><td></td></tr><tr><td valign="top"><a href="#find_files-2">find_files/2</a></td><td></td></tr><tr><td valign="top"><a href="#find_files-3">find_files/3</a></td><td></td></tr><tr><td valign="top"><a href="#find_ini_files-1">find_ini_files/1</a></td><td></td></tr><tr><td valign="top"><a href="#implode-2">implode/2</a></td><td></td></tr><tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td></td></tr><tr><td valign="top"><a href="#trim_whitespace-1">trim_whitespace/1</a></td><td>trims whitespace.</td></tr></table>
 
 
 <a name="functions"></a>
@@ -66,3 +66,10 @@
 `to_list(V) -> any()`
 
 
+<a name="trim_whitespace-1"></a>
+
+### trim_whitespace/1 ###
+
+`trim_whitespace(Value) -> any()`
+
+trims whitespace

doc/utf8/README.md

@@ -0,0 +1,72 @@
+
+
+# econfig - simple Erlang config handler using INI files #
+
+Copyright (c) 2012-2014 Benoît Chesneau.
+
+__Version:__ 0.4.2
+
+# econfig
+
+econfig is a simple Erlang config handler to manage a config from INI
+files.
+
+econfig can be use to read and update INI files. Values are cached in an
+ETS table and you can manage multiple configuration profiles. A process
+can also subscribe to config updates events.
+
+Autoreload of the config when an INI file is updated is supported, you can even
+manage changes from a full config directory.
+
+See the [NEWS](http://github.com/benoitc/econfig/blob/master/NEWS.md)
+for last changes.
+
+## Examples
+
+Quick usage example:
+
+```
+1> application:start(gproc).
+ok
+2> application:start(econfig).
+ok
+3> econfig:register_config(couchdb, ["/Users/benoitc/refuge/rcouch/rel/rcouch/etc/default.ini", "/Users/benoitc/refuge/rcouch/rel/rcouch/etc/local.ini"], [autoreload]).
+ok
+4> econfig:subscribe(couchdb).
+true
+5> econfig:get_value(couchdb, "couchdb").
+[{"delayed_commits","true"},
+ {"file_compression","snappy"},
+ {"os_process_timeout","5000"},
+ {"uri_file","./data/couch.uri"},
+ {"index_dir","./data"},
+ {"max_document_size","4294967296"},
+ {"database_dir","./data"},
+ {"max_dbs_open","100"}]
+6> econfig:set_value(couchdb, "ssl", "test", "1").
+ok
+7> flush().
+Shell got {config_updated,couchdb,{set,{"ssl","test"}}}
+ok
+```
+
+Contribute
+----------
+For issues, comments or feedback please [create an issue!] [1]
+[1]: http://github.com/benoitc/econfig/issues "econfig issues"
+
+
+## Modules ##
+
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="econfig.md" class="module">econfig</a></td></tr>
+<tr><td><a href="econfig_app.md" class="module">econfig_app</a></td></tr>
+<tr><td><a href="econfig_deps.md" class="module">econfig_deps</a></td></tr>
+<tr><td><a href="econfig_file_writer.md" class="module">econfig_file_writer</a></td></tr>
+<tr><td><a href="econfig_server.md" class="module">econfig_server</a></td></tr>
+<tr><td><a href="econfig_sup.md" class="module">econfig_sup</a></td></tr>
+<tr><td><a href="econfig_util.md" class="module">econfig_util</a></td></tr>
+<tr><td><a href="econfig_watcher.md" class="module">econfig_watcher</a></td></tr>
+<tr><td><a href="econfig_watcher_sup.md" class="module">econfig_watcher_sup</a></td></tr></table>
+