From 31aae5aae15db6abb59d9d5a0a922cc22a515b96 Mon Sep 17 00:00:00 2001
From: Andre Polykanine <ap@oire.me>
Date: Mon, 8 Mar 2021 00:07:21 +0100
Subject: [PATCH] Add table of contents to Readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index b9aab89..50a7e43 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,39 @@
 Welcome to Iridium, a security library for encrypting data, hashing passwords and managing secure tokens!  
 This library consists of several classes, or modules, and can be used for hashing and verifying passwords, encrypting and decrypting data, as well as for managing secure tokens suitable for authentication cookies, password reset, API access and various other tasks.
 
+# Table of Contents
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Running Tests](#running-tests)
+* [Base64 Handling, URL\-safe Way](#base64-handling-url-safe-way)
+    * [Usage Examples](#usage-examples)
+    * [Methods](#methods)
+* [Crypt](#crypt)
+    * [Symmetric Key](#symmetric-key)
+        * [Symmetric Key Methods](#symmetric-key-methods)
+    * [Crypt Usage Examples](#crypt-usage-examples)
+    * [Exceptions](#exceptions)
+    * [Methods](#methods-1)
+* [Password](#password)
+    * [Usage Examples](#usage-examples-1)
+    * [Methods](#methods-2)
+* [Osst, Simple Yet Secure Tokens Suitable for Authentication Cookies and Password Recovery](#osst-simple-yet-secure-tokens-suitable-for-authentication-cookies-and-password-recovery)
+    * [The Split Tokens Concept](#the-split-tokens-concept)
+    * [Usage Examples](#usage-examples-2)
+        * [Create a Table](#create-a-table)
+        * [Create a Token](#create-a-token)
+        * [Set and Validate a User\-Provided Token](#set-and-validate-a-user-provided-token)
+        * [Revoke a Token](#revoke-a-token)
+        * [Clear Expired Tokens](#clear-expired-tokens)
+        * [Three Ways of Setting Expiration Time](#three-ways-of-setting-expiration-time)
+        * [Notes on Expiration Times](#notes-on-expiration-times)
+        * [Encrypt Additional Information](#encrypt-additional-information)
+    * [Error Handling](#error-handling)
+    * [Methods](#methods-3)
+* [Contributing](#contributing)
+* [License](#license)
+
 ## Requirements
 
 Requires PHP 7.3 or later with _PDO_, _Mbstring_ and _OpenSSL_ enabled.