Added README.
authorStanislaw Klekot <dozzie@jarowit.net>
Tue, 18 Feb 2014 19:18:39 +0000 (20:18 +0100)
committerStanislaw Klekot <dozzie@jarowit.net>
Tue, 18 Feb 2014 19:18:39 +0000 (20:18 +0100)
README [new file with mode: 0644]
debian/erlang-eni.docs
redhat/erlang-eni.spec
src/overview.edoc

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..5ceb939
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+== ENI ==
+
+ENI is a configuration format based on dead-simple INI known from DOS and
+Windows. ENI is a superset of (one of the variants of) INI -- ENI additionally
+supports Erlang terms in config.
+
+ENI is not intended to be used inside typical Erlang application. There is
+already well established practice of keeping default configuration in `*.app'
+file and customizing it by setting environment.
+
+ENI is meant mainly for maintainers writing tools that interact with system
+administrator. Such tools usually are scripts for starting a daemon or
+command line tools, standalone or for issuing commands to a daemon.
+
+== Examples ==
+
+Usage examples:
+
+  % loading config from file
+  {ok, Conf} = eni:file("file.eni"),
+  % loading config from in-memory string
+  {ok, Conf} = eni:string("..."),
+
+  {Opts, Sections} = Conf,
+  Foo = proplists:get_value(foo, Opts),
+  BarSect = proplists:get_value(bar, Sections),
+  Bar_Baz = proplists:get_value(baz, BarSect).
+
+
+Short example of ENI file:
+
+  ; traditional INI comment
+  # more "unixish" comment
+  % and "erlangish" comment
+
+  pid_file = /var/run/erl_daemon.pid
+  enabled_services := [http, https].
+
+  [http]
+  bind = 127.0.0.1
+  port := [8080, 8880].
+
+  [https]
+  bind := any.
+  port = 8443
+  ssl_cert = /etc/erl_daemon/cert.pem
+  ssl_key  = /etc/erl_daemon/key.pem
index 5ecd9c6..2e3abae 100644 (file)
@@ -1 +1,2 @@
 COPYING
+README
index 8b0618b..834236c 100644 (file)
@@ -75,6 +75,7 @@ rm -rf $RPM_BUILD_ROOT
 %files
 %defattr(-,root,root,-)
 %doc COPYING
+%doc README
 %exclude %{_app_doc}
 %exclude %{_app_src}
 %{_app_libdir}
index 7a6f29e..8c96a1e 100644 (file)
@@ -7,6 +7,51 @@ ENI is a configuration format based on dead-simple INI known from DOS and
 Windows. ENI is a superset of (one of the variants of) INI -- ENI additionally
 supports Erlang terms in config.
 
+ENI is not intended to be used inside typical Erlang application. There is
+already well established practice of keeping default configuration in `*.app'
+file and customizing it by setting environment.
+
+ENI is meant mainly for maintainers writing tools that interact with system
+administrator. Such tools usually are scripts for starting a daemon or
+command line tools, standalone or for issuing commands to a daemon.
+
 You can find detailed format description here: {@link file_format}.
 
+== Examples ==
+
+Usage examples:
+
+```
+% loading config from file
+{ok, Conf} = eni:file("file.eni"),
+% loading config from in-memory string
+{ok, Conf} = eni:string("..."),
+
+{Opts, Sections} = Conf,
+Foo = proplists:get_value(foo, Opts),
+BarSect = proplists:get_value(bar, Sections),
+Bar_Baz = proplists:get_value(baz, BarSect).
+'''
+
+Short example of ENI file:
+
+```
+; traditional INI comment
+# more "unixish" comment
+% and "erlangish" comment
+
+pid_file = /var/run/erl_daemon.pid
+enabled_services := [http, https].
+
+[http]
+bind = 127.0.0.1
+port := [8080, 8880].
+
+[https]
+bind := any.
+port = 8443
+ssl_cert = /etc/erl_daemon/cert.pem
+ssl_key  = /etc/erl_daemon/key.pem
+'''
+
 <!-- vim:set ft=edoc: -->