Skip to content

Commit

Permalink
add toc to readme (a-luna#49)
Browse files Browse the repository at this point in the history
Fixes a-luna#42
  • Loading branch information
a-luna authored Jun 29, 2021
1 parent 56aee43 commit 2ef5d9a
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## fastapi-redis-cache
## fastapi-redis-cache <!-- omit in toc -->

[![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)
Expand All @@ -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.
Expand Down

0 comments on commit 2ef5d9a

Please sign in to comment.