From ea67acaf9623adee642516a6329c9aad0d006779 Mon Sep 17 00:00:00 2001 From: Aaron Luna Date: Tue, 29 Jun 2021 04:42:22 -0700 Subject: [PATCH] add toc to readme Fixes #42 --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 967cbd4..6378ccd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## fastapi-redis-cache +## fastapi-redis-cache [![PyPI version](https://badge.fury.io/py/fastapi-redis-cache.svg)](https://badge.fury.io/py/fastapi-redis-cache) ![PyPI - Downloads](https://img.shields.io/pypi/dm/fastapi-redis-cache?color=%234DC71F) @@ -7,6 +7,17 @@ [![Maintainability](https://api.codeclimate.com/v1/badges/ec0b1d7afb21bd8c23dc/maintainability)](https://codeclimate.com/github/a-luna/fastapi-redis-cache/maintainability) [![codecov](https://codecov.io/gh/a-luna/fastapi-redis-cache/branch/main/graph/badge.svg?token=dUaILJcgWY)](https://codecov.io/gh/a-luna/fastapi-redis-cache) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) + - [Initialize Redis](#initialize-redis) + - [`@cache` Decorator](#cache-decorator) + - [Response Headers](#response-headers) + - [Pre-defined Lifetimes](#pre-defined-lifetimes) + - [Cache Keys](#cache-keys) + - [Cache Keys Pt 2.](#cache-keys-pt-2) +- [Questions/Contributions](#questionscontributions) + ## Features - Cache response data for async and non-async path operation functions.