1 files changed, 46 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..3330122
--- /dev/null
+++ b/README
@@ -0,0 +1,46 @@
+Config::HAProxy
+===============
+
+A parser class that converts the HAProxy configuration file to a parse
+tree and provides methods for various operations on this tree, such as:
+searching, modifying and saving it to a file.
+
+EXAMPLE
+
+  use Config::HAProxy;
+  
+  # Parse HAProxy configuration file
+  $cfg = Config::HAProxy->new->parse;
+
+  # Print IP addresses and ports of the configured backends
+  foreach my $srv (map { $_->select(name => 'server') }
+                   $cfg->tree->select(name => 'backend')) {
+     print $srv->arg(1),"\n";
+  }
+
+
+INSTALLATION
+
+To install this module type the following:
+
+   perl Makefile.PL
+   make
+   make test
+   make install
+
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2018 by Sergey Poznyakoff
+
+This library is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 3 of the License, or (at your
+option) any later version.
+
+It is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this library. If not, see <http://www.gnu.org/licenses/>.