From ac7dee226001e2d056e74fd95af01c85dfb265ed Mon Sep 17 00:00:00 2001
From: Mattia Verga <mattia.verga@tiscali.it>
Date: Feb 29 2020 09:18:52 +0000
Subject: Add README file


---

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ecf5e2e
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,52 @@
+review_stats
+============
+A tool to generate cached HTML pages with statistics about Fedora review tickets.
+
+Description
+-----------
+This tool is used by fedora-infrastructure to generate some HTML pages with useful statistics about new package review tickets opened in Red Hat Bugzilla.
+
+Usage
+-----
+.. code:: bash
+
+   review-stats -c <CONFIG_FILE> -d <OUTPUT_HTML_DIR>
+
+`review_stats` requires a configuration file to be set up before usage. An example `review-stats.cfg` is provided by the package.
+
+Config file parameters description
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**url**: URL of the xmlrpc Bugzilla server instance. Defaults to Red Hat Bugzilla server.
+
+**username** / **password**: for authentication to the Bugzilla server.
+
+**bugzilla_api_key**: alternative to username/password authentication.
+
+**journal_level**: store run information to systemd journal with the desired level.
+
+**mail_level**: send log messages of the desired level to a list of email addresses. Be aware these addresses will receive one email for each log message sent to the queue! Using a level lower than ERROR is discouraged.
+
+**mail_server**: the SMTP server to use for sending emails with the format `server:port`.
+
+**mail_username** / **mail_password**: for authentication to the SMTP server.
+
+**mail_secure**: set to true if SSL authentication is needed.
+
+**mail_from**: sender address.
+
+**mail_to**: comma separated list of email addresses.
+
+CLI parameters
+^^^^^^^^^^^^^^
+**-c, --config FILENAME [required]**: the config file to use.
+
+**-t, --templatedir PATH**: a path to the directory where HTML templates are stored. By default the script will automatically search for them in the package install dir.
+
+***-s, --staticfilesdir PATH**: a path to the directory where static files are stored. By default the script will automatically search for them in the package install dir.
+
+**-d, --destination PATH [required]**: the path where generated HTML files should be copied.
+
+**-v, --verbose**: set console output to INFO level.
+
+**-D, --debug**: set console output to DEBUG level.
+