Skip to content

Commit

Permalink
docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
igorbenav committed Jan 24, 2024
1 parent f135924 commit abcb6b9
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://github.com/igorbenav/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">
<img src="https://github.com/igorbenav/fastcrud/blob/main/assets/fastcrud_with_background.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>
<p align="center" markdown=1>
Expand Down Expand Up @@ -70,16 +70,20 @@ Below are examples demonstrating both approaches:

<h3>Using crud_router for Automatic Endpoint Creation</h3>

> \[!WARNING\]
> For now, your primary column must be named `id` or automatic endpoint creation will not work.
Here's a quick example to get you started:

<h4>Define Your Model and Schema</h4>

```python
from sqlalchemy import Column, Integer, String
from sqlalchemy.orm import declarative_base
from sqlalchemy.orm import DeclarativeBase
from pydantic import BaseModel

Base = declarative_base()
class Base(DeclarativeBase):
pass

class Item(Base):
__tablename__ = 'items'
Expand Down
Binary file added assets/fastcrud_with_background.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.0"
version = "0.1.3"
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 abcb6b9

Please sign in to comment.