table of contents

README.md

@@ -1,6 +1,24 @@
 ![Logo](.README_images/full_logo.png)
 
-# Overview ![Java CI](https://github.com/ExpediaGroup/beekeeper/workflows/Java%20CI/badge.svg?event=push) [![Coverage Status](https://coveralls.io/repos/github/ExpediaGroup/beekeeper/badge.svg?branch=main)](https://coveralls.io/github/ExpediaGroup/beekeeper?branch=main) ![GitHub license](https://img.shields.io/github/license/ExpediaGroup/beekeeper.svg)
+![Java CI](https://github.com/ExpediaGroup/beekeeper/workflows/Java%20CI/badge.svg?event=push) [![Coverage Status](https://coveralls.io/repos/github/ExpediaGroup/beekeeper/badge.svg?branch=main)](https://coveralls.io/github/ExpediaGroup/beekeeper?branch=main) ![GitHub license](https://img.shields.io/github/license/ExpediaGroup/beekeeper.svg)
+# Table of contents 
+
+- [Overview](#overview)
+  - [Start using](#start-using)
+- [How does it work?](#how-does-it-work)
+  - [Beekeeper Architecture](#beekeeper-architecture)
+  - [Unreferenced paths](#unreferenced-paths)
+  - [Time To Live, TTL](#time-to-live-ttl)
+  - [Hive table configuration](#hive-table-configuration)
+- [Running Beekeeper](#running-beekeeper)
+  - [Using Docker](#using-docker)
+  - [Endpoints](#endpoints)
+  - [Application configuration](#application-configuration)
+  - [Beekeeper-API](#beekeeper-api)
+- [External links](#external-links)
+- [Legal](#legal)
+
+# Overview
 
 Beekeeper is a service that schedules orphaned paths and expired metadata for deletion.