Skip to content

Commit

Permalink
docs reference
Browse files Browse the repository at this point in the history
  • Loading branch information
igorbenav committed Jan 25, 2024
1 parent 4f90be6 commit 91d0575
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://github.com/igorbenav/fastcrud">
<a href="https://igorbenav.github.io/fastcrud/">
<img src="https://github.com/igorbenav/fastcrud/blob/main/assets/fastcrud.png?raw=true" alt="FastCRUD written in white with a drawing of a gear and inside this gear a bolt." width="45%" height="auto">
</a>
</p>
Expand All @@ -21,7 +21,7 @@
<p align="justify">
<b>FastCRUD</b> is a Python package for <b>FastAPI</b>, offering robust async CRUD operations and flexible endpoint creation utilities, streamlined through advanced features like <b>auto-detected join</b> conditions, <b>dynamic sorting</b>, and offset and cursor <b>pagination</b>.
</p>
<p><b>Documentation: 🚧 Coming Soon 🚧</b></p>
<p><b>Documentation</b>: <a href="https://igorbenav.github.io/fastcrud/">igorbenav.github.io/fastcrud</a></p>
<hr>
<h2>Features</h2>

Expand Down Expand Up @@ -169,6 +169,7 @@ async def read_item(item_id: int, db: AsyncSession = Depends(async_session)):

In this example, we define custom endpoints for creating and reading items using FastCRUD directly, providing more flexibility in how the endpoints are structured and how the responses are handled.

To read more detailed descriptions, go to the <a href="https://igorbenav.github.io/fastcrud/">documentation</a>.

## References

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "fastcrud"
version = "0.1.6"
version = "0.1.8"
description = "FastCRUD is a Python package for FastAPI, offering robust async CRUD operations and flexible endpoint creation utilities."
authors = ["Igor Benav <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit 91d0575

Please sign in to comment.