Skip to content

Commit cfb1fcf

Browse files
committed
Update readme
1 parent 8b89aea commit cfb1fcf

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ frameworks:
3030
- [Flask](https://docs.apitally.io/frameworks/flask)
3131
- [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
3232
- [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
33+
- [Litestar](https://docs.apitally.io/frameworks/litestar)
3334

3435
Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
3536
the 📚 [documentation](https://docs.apitally.io).
@@ -50,7 +51,8 @@ example:
5051
pip install apitally[fastapi]
5152
```
5253

53-
The available extras are: `fastapi`, `starlette`, `flask` and `django`.
54+
The available extras are: `fastapi`, `starlette`, `flask`, `django` and
55+
`litestar`.
5456

5557
## Usage
5658

@@ -112,6 +114,27 @@ APITALLY_MIDDLEWARE = {
112114
}
113115
```
114116

117+
### Litestar
118+
119+
This is an example of how to add the Apitally plugin to a Litestar application.
120+
For further instructions, see our
121+
[setup guide for Litestar](https://docs.apitally.io/frameworks/litestar).
122+
123+
```python
124+
from litestar import Litestar
125+
from apitally.litestar import ApitallyPlugin
126+
127+
app = Litestar(
128+
route_handlers=[...],
129+
plugins=[
130+
ApitallyPlugin(
131+
client_id="your-client-id",
132+
env="dev", # or "prod" etc.
133+
),
134+
]
135+
)
136+
```
137+
115138
## Getting help
116139

117140
If you need help please

0 commit comments

Comments
 (0)