Skip to content

Commit e83aef8

Browse files
committed
Fixed documentation
1 parent 7a46bb1 commit e83aef8

2 files changed

Lines changed: 40 additions & 28 deletions

File tree

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,31 @@ orms:
4040
django, tortoise-orm, pony, sqlalchemy
4141

4242
```bash
43-
pip install fastadmin["fastapi,django"] # for fastapi with django orm
44-
pip install fastadmin["fastapi,tortoise-orm"] # for fastapi with tortoise orm
45-
pip install fastadmin["fastapi,pony"] # for fastapi with pony orm
46-
pip install fastadmin["fastapi,sqlalchemy"] # for fastapi with sqlalchemy orm
47-
pip install fastadmin["django"] # for django with django orm
48-
pip install fastadmin["django,pony"] # for django with pony orm
49-
pip install fastadmin["flask,sqlalchemy"] # for flask with sqlalchemy
43+
pip install fastadmin[fastapi,django] # for fastapi with django orm
44+
pip install fastadmin[fastapi,tortoise-orm] # for fastapi with tortoise orm
45+
pip install fastadmin[fastapi,pony] # for fastapi with pony orm
46+
pip install fastadmin[fastapi,sqlalchemy] # for fastapi with sqlalchemy orm
47+
pip install fastadmin[django] # for django with django orm
48+
pip install fastadmin[django,pony] # for django with pony orm
49+
pip install fastadmin[flask,sqlalchemy] # for flask with sqlalchemy
5050
...
5151
```
5252

53+
for (macos) zsh use
54+
```bash
55+
pip install fastadmin\[fastapi,django\]
56+
```
57+
5358
or using poetry
5459

5560
```bash
56-
poetry add 'fastadmin["fastapi,django"]' # for fastapi with django orm
57-
poetry add 'fastadmin["fastapi,tortoise-orm"]' # for fastapi with tortoise orm
58-
poetry add 'fastadmin["fastapi,pony"]' # for fastapi with pony orm
59-
poetry add 'fastadmin["fastapi,sqlalchemy"]' # for fastapi with sqlalchemy orm
60-
poetry add 'fastadmin["django"]' # for django with django orm
61-
poetry add 'fastadmin["django,pony"]' # for django with pony orm
62-
poetry add 'fastadmin["flask,sqlalchemy"]' # for flask with sqlalchemy
61+
poetry add 'fastadmin[fastapi,django]' # for fastapi with django orm
62+
poetry add 'fastadmin[fastapi,tortoise-orm]' # for fastapi with tortoise orm
63+
poetry add 'fastadmin[fastapi,pony]' # for fastapi with pony orm
64+
poetry add 'fastadmin[fastapi,sqlalchemy]' # for fastapi with sqlalchemy orm
65+
poetry add 'fastadmin[django]' # for django with django orm
66+
poetry add 'fastadmin[django,pony]' # for django with pony orm
67+
poetry add 'fastadmin[flask,sqlalchemy]' # for flask with sqlalchemy
6368
...
6469
```
6570

docs/index.html

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -268,26 +268,33 @@ <h3>Installation</h3>
268268
<p class="lead">Install the package using pip:</p>
269269
<pre>
270270
<code class="language-bash">
271-
pip install fastadmin["fastapi,django"] # for fastapi with django orm
272-
pip install fastadmin["fastapi,tortoise-orm"] # for fastapi with tortoise orm
273-
pip install fastadmin["fastapi,pony"] # for fastapi with pony orm
274-
pip install fastadmin["fastapi,sqlalchemy"] # for fastapi with sqlalchemy orm
275-
pip install fastadmin["django"] # for django with django orm
276-
pip install fastadmin["django,pony"] # for django with pony orm
277-
pip install fastadmin["flask,sqlalchemy"] # for flask with sqlalchemy
271+
pip install fastadmin[fastapi,django] # for fastapi with django orm
272+
pip install fastadmin[fastapi,tortoise-orm] # for fastapi with tortoise orm
273+
pip install fastadmin[fastapi,pony] # for fastapi with pony orm
274+
pip install fastadmin[fastapi,sqlalchemy] # for fastapi with sqlalchemy orm
275+
pip install fastadmin[django] # for django with django orm
276+
pip install fastadmin[django,pony] # for django with pony orm
277+
pip install fastadmin[flask,sqlalchemy] # for flask with sqlalchemy
278+
...
279+
</code>
280+
</pre>
281+
<p class="lead">for zsh (macos) use:</p>
282+
<pre>
283+
<code class="language-bash">
284+
pip install fastadmin\[fastapi,django\]
278285
...
279286
</code>
280287
</pre>
281288
<p class="lead">Or using poetry:</p>
282289
<pre>
283290
<code class="language-bash">
284-
poetry add 'fastadmin["fastapi,django"]' # for fastapi with django orm
285-
poetry add 'fastadmin["fastapi,tortoise-orm"]' # for fastapi with tortoise orm
286-
poetry add 'fastadmin["fastapi,pony"]' # for fastapi with pony orm
287-
poetry add 'fastadmin["fastapi,sqlalchemy"]' # for fastapi with sqlalchemy orm
288-
poetry add 'fastadmin["django"]' # for django with django orm
289-
poetry add 'fastadmin["django,pony"]' # for django with pony orm
290-
poetry add 'fastadmin["flask,sqlalchemy"]' # for flask with sqlalchemy
291+
poetry add 'fastadmin[fastapi,django]' # for fastapi with django orm
292+
poetry add 'fastadmin[fastapi,tortoise-orm]' # for fastapi with tortoise orm
293+
poetry add 'fastadmin[fastapi,pony]' # for fastapi with pony orm
294+
poetry add 'fastadmin[fastapi,sqlalchemy]' # for fastapi with sqlalchemy orm
295+
poetry add 'fastadmin[django]' # for django with django orm
296+
poetry add 'fastadmin[django,pony]' # for django with pony orm
297+
poetry add 'fastadmin[flask,sqlalchemy]' # for flask with sqlalchemy
291298
...
292299
</code>
293300
</pre>

0 commit comments

Comments
 (0)