Merge pull request #255 from karel-brinda/rme

Add shields to readme

README.md

@@ -16,30 +16,37 @@ to align batches of queries to them by
 all within only several hours.
 </p><br/>
 
+[![Info](https://img.shields.io/badge/Project-Info-blue)](https://brinda.eu/mof)
+[![Paper DOI](https://zenodo.org/badge/DOI/10.1101/2023.04.15.536996.svg)](https://doi.org/10.1101/2023.04.15.536996)
+[![Tests](https://github.com/karel-brinda/mof-search/actions/workflows/ci.yaml/badge.svg)](https://github.com/karel-brinda/mof-search/actions/)
+[![GitHub release](https://img.shields.io/github/release/karel-brinda/mof-search.svg)](https://github.com/karel-brinda/mof-search/releases/)
+
+<h2>Contents</h2>
+
 <!-- vim-markdown-toc GFM -->
 
 * [1. Introduction](#1-introduction)
-    * [Citation](#citation)
+  * [Citation](#citation)
 * [2. Requirements](#2-requirements)
-    * [2a) Hardware](#2a-hardware)
-    * [2b) Dependencies](#2b-dependencies)
+  * [2a) Hardware](#2a-hardware)
+  * [2b) Dependencies](#2b-dependencies)
 * [3. Installation](#3-installation)
-    * [3a) Step 1: Install dependencies](#3a-step-1-install-dependencies)
-    * [3b) Step 2: Clone the repository](#3b-step-2-clone-the-repository)
-    * [3c) Step 3: Run a simple test](#3c-step-3-run-a-simple-test)
-    * [3d) Step 4: Download the database](#3d-step-4-download-the-database)
+  * [3a) Step 1: Install dependencies](#3a-step-1-install-dependencies)
+  * [3b) Step 2: Clone the repository](#3b-step-2-clone-the-repository)
+  * [3c) Step 3: Run a simple test](#3c-step-3-run-a-simple-test)
+  * [3d) Step 4: Download the database](#3d-step-4-download-the-database)
 * [4. Usage](#4-usage)
-    * [4a) Step 1: Copy or symlink your queries](#4a-step-1-copy-or-symlink-your-queries)
-    * [4b) Step 2: Adjust configuration](#4b-step-2-adjust-configuration)
-    * [4c) Step 3: Clean up intermediate files](#4c-step-3-clean-up-intermediate-files)
-    * [4d) Step 4: Run the pipeline](#4d-step-4-run-the-pipeline)
-    * [4e) Step 5: Analyze your results](#4e-step-5-analyze-your-results)
+  * [4a) Step 1: Copy or symlink your queries](#4a-step-1-copy-or-symlink-your-queries)
+  * [4b) Step 2: Adjust configuration](#4b-step-2-adjust-configuration)
+  * [4c) Step 3: Clean up intermediate files](#4c-step-3-clean-up-intermediate-files)
+  * [4d) Step 4: Run the pipeline](#4d-step-4-run-the-pipeline)
+  * [4e) Step 5: Analyze your results](#4e-step-5-analyze-your-results)
 * [5. Additional information](#5-additional-information)
-    * [5a) List of workflow commands](#5a-list-of-workflow-commands)
-    * [5b) Directories](#5b-directories)
-    * [5c) File formats](#5c-file-formats)
-    * [5d) Running on a cluster](#5d-running-on-a-cluster)
-    * [5e) Known limitations](#5e-known-limitations)
+  * [5a) List of workflow commands](#5a-list-of-workflow-commands)
+  * [5b) Directories](#5b-directories)
+  * [5c) File formats](#5c-file-formats)
+  * [5d) Running on a cluster](#5d-running-on-a-cluster)
+  * [5e) Known limitations](#5e-known-limitations)
 * [6. License](#6-license)
 * [7. Contacts](#7-contacts)