Permalink
Browse files

README now uses MarkDown

  • Loading branch information...
1 parent a69a649 commit ad93c9ffcaa8552f03eca233302ce3add2dd4cd2 @cbonte committed Nov 4, 2012
Showing with 19 additions and 7 deletions.
  1. +0 −7 README
  2. +19 −0 README.md
View
7 README
@@ -1,7 +0,0 @@
-HAProxy Documentation Converter
-
-Made to convert the HAProxy documentation into HTML.
-More than HTML, the main goal is to provide easy navigation.
-
-This is a early preversion with ugly and not self explanatory code :
-cleanups and enhancements are very welcomed !
View
@@ -0,0 +1,19 @@
+# HAProxy Documentation Converter
+
+Made to convert the HAProxy documentation into HTML.
+
+More than HTML, the main goal is to provide easy navigation.
+
+## Documentations
+
+A bot periodically fetches last commits for HAProxy 1.4 and 1.5 to produce up-to-date documentations.
+
+Converted documentations are then stored online :
+- [HAProxy 1.4 Configuration Manual](http://cbonte.github.com/haproxy-dconv/configuration-1.4.html)
+- [HAProxy 1.5 Configuration Manual](http://cbonte.github.com/haproxy-dconv/configuration-1.5.html)
+
+## Contribute
+
+The project now lives by itself, as it is sufficiently useable. But I'm sure we can do even better.
+Feel free to report feature requests or to provide patches !
+

0 comments on commit ad93c9f

Please sign in to comment.