Skip to content

Commit 74e7406

Browse files
committed
docs updated with logo
1 parent 6e5c9b5 commit 74e7406

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
1-
# FastAPI-boilerplate
2-
>A template to speed your FastAPI development up.
1+
<h1 align="center"> Fast FastAPI boilerplate</h1>
2+
<p align="center" markdown=1>
3+
<i>Yet another template to speed your FastAPI development up.</i>
4+
</p>
5+
6+
<p align="center">
7+
<a href="https://github.com/igormagalhaesr/FastAPI-boilerplate">
8+
<img src="https://user-images.githubusercontent.com/43156212/277095260-ef5d4496-8290-4b18-99b2-0c0b5500504e.png" width="30%" height="auto">
9+
</a>
10+
</p>
11+
312

413
## 0. About
514
**FastAPI boilerplate** creates an extendable async API using FastAPI, Pydantic V2, SQLAlchemy 2.0 and PostgreSQL:
@@ -68,7 +77,7 @@ Then install poetry:
6877
pip install poetry
6978
```
7079

71-
In the **src** directory, run to install required packages:
80+
In the `src` directory, run to install required packages:
7281
```sh
7382
poetry install
7483
```
@@ -437,8 +446,9 @@ async def patch_post(
437446
```
438447

439448
> **Warning**
440-
> Note that this will not work for **GET** requests.
449+
> Note that adding `to_invalidate_extra` will not work for **GET** requests.
441450
451+
#### Client-side Caching
442452
For `client-side caching`, all you have to do is let the `Settings` class defined in `app/core/config.py` inherit from the `ClientSideCacheSettings` class. You can set the `CLIENT_CACHE_MAX_AGE` value in `.env,` it defaults to 60 (seconds).
443453

444454
### 9.9 Running

0 commit comments

Comments
 (0)