Merge pull request #56 from redBorder/add_doxygen_doc

PR-52: Update doxyfile and create mainpage

Doxyfile

@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  += README.md
+INPUT                  = /resources/src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1165,7 +1165,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = README.md
+USE_MDFILE_AS_MAINPAGE = RBAIOUTLIERS.md 
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common

resources/src/RBAIOUTLIERS.md

@@ -0,0 +1,6 @@
+# rb-aioutliers: Advanced Anomaly Detection for Network Traffic Data
+
+## Introduction
+
+rb-aioutliers offers advanced anomaly detection in network traffic data, leveraging unsupervised machine learning on Druid. It features a self-training deep learning model adaptable to both univariate and multivariate data, optimized for distributed training. Initially configured for RedBorder platforms, rb-aioutliers is customizable for any Druid setup, providing efficient and scalable anomaly detection solutions.
+