update docs

README.rst

@@ -0,0 +1,50 @@
+.. image:: https://readthedocs.org/projects/af-benchmark/badge/?version=latest
+    :target: https://af-benchmark.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://github.com/PurdueAF/af-benchmark/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/PurdueAF/af-benchmark/actions/workflows/ci.yml/badge.svg
+    :alt: CI Status
+
+
+Analysis Facility Benchmark
+============================
+
+|docs_link|
+
+.. |docs_link| raw:: html
+
+   <a href="https://af-benchmark.readthedocs.io" target="_blank">
+      https://af-benchmark.readthedocs.io
+   </a>
+
+.. start-badge
+
+**🏗️ Work in progress 🚧**
+
+
+This benchmark is designed for generic but comprehensive performance tests of the computing infrastructure at CMS Analysis Facilities. It currently includes the following functionality:
+
+* Multiple options for code execution:
+
+  * Sequential
+  * Parallelized via ``concurrent.futures``
+  * Parallelized via ``Dask`` using local cluster
+  * Parallelized via ``Dask`` using Gateway cluster
+
+* Multiple methods of loading and reading columns from NanoAOD ROOT files:
+
+  * ``uproot``
+  * ``coffea.nanoevents``
+
+* Generic operations applied to data in columns:
+
+  * Nothing (just open the ROOT file with a given method)
+  * Load column data into memory
+  * Perform a simple operation on a column, e.g. ``mean()``
+
+* Time profiling
+* Measuring size of columns in bytes
+
+.. end-badge
+

docs/source/index.rst

@@ -1,5 +1,9 @@
-.. include:: ../../README.md
+.. include:: ../../README.rst
+   :start-after: .. start-badge
+   :end-before: .. end-badge
 
 .. toctree::
+    :caption: API reference
+    :maxdepth: 2
 
     modules/modules