Update docs

logpai · May 31, 2018 · b535706 · b535706
1 parent f2772c2
commit b535706
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 22 deletions.
diff --git a/docs/README (2).rst b/docs/README (2).rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,25 @@
+Welcome to logparser's documentation!
+=====================================
+
+Logparser provides a toolkit and benchmarks for automated log parsing, which is a crucial step towards structured log analytics. Logparser implements a number of state-of-the-art data-driven approaches for this goal. By applying logparser, users can automatically learn event templates from unstructured logs and convert raw log messages into a sequence of structured events. 
+
+.. toctree::
+   :maxdepth: 1
+   :caption: INSTALLATION
+
+   installation/install_docker
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contributors
+
+   contributor
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+