Skip to content

Commit c7e5586

Browse files
authored
Minor grammar fixes for README.md
1 parent 2a96b86 commit c7e5586

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020

2121

2222
- [Introduction](#introduction)
23-
- [Advantage](#advantage)
24-
- [Constraint](#constraint)
23+
- [Advantages](#advantages)
24+
- [Limitations](#limitations)
2525
- [Getting started](#getting-started)
2626
- [Installation](#installation)
2727
- [Usage](#usage)
@@ -38,9 +38,9 @@
3838

3939
# Introduction
4040

41-
I believe that everyone who's working with FastApi and building some RESTful of CRUD services, wastes the time to writing similar code for simple CRUD every time
41+
I believe that many people who work with FastApi to build RESTful CRUD services end up wasting time writing repitive boilerplate code.
4242

43-
`FastAPI Quick CRUD` can generate CRUD in FastApi with SQLAlchemy schema
43+
`FastAPI Quick CRUD` can generate CRUD methods in FastApi from an SQLAlchemy schema:
4444

4545
- Get one
4646
- Get many
@@ -58,9 +58,9 @@ I believe that everyone who's working with FastApi and building some RESTful of
5858

5959
![docs page](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/pic/page_preview.png?raw=true)
6060

61-
## Advantage
61+
## Advantages
6262

63-
- [x] **Support SQLAlchemy 1.4** - Allow you build a fully asynchronous python service, also supports synchronization.
63+
- [x] **Support SQLAlchemy 1.4** - Allows you build a fully asynchronous or synchronous python service
6464

6565
- [x] **Full SQLAlchemy DBAPI Support** - Support different SQL for SQLAlchemy
6666

@@ -74,11 +74,11 @@ I believe that everyone who's working with FastApi and building some RESTful of
7474

7575
- [x] **SQL Relationship** - `FIND ONE/MANY` supports Path get data with relationship
7676

77-
## Constraint
77+
## Limitations
7878

7979
- ❌ If there are multiple **unique constraints**, please use **composite unique constraints** instead
80-
-**Composite primary key** is not support
81-
-Not Support API requests with specific resource `xxx/{primary key}` when table have not primary key;
80+
-**Composite primary key** is not supported
81+
-Unsupported API requests with on resources `xxx/{primary key}` for tables without a primary key;
8282
- `UPDATE ONE`
8383
- `FIND ONE`
8484
- `PATCH ONE`
@@ -88,8 +88,7 @@ I believe that everyone who's working with FastApi and building some RESTful of
8888
# Getting started
8989

9090
##
91-
Welcome if you can accept the dependency version
92-
I will take the time to update the version dependencies as soon as possible to ensure that the core dependencies of this project have the highest version
91+
I try to update the version dependencies as soon as possible to ensure that the core dependencies of this project have the highest version possible.
9392
```bash
9493
fastapi<=0.68.2
9594
pydantic<=1.8.2
@@ -111,7 +110,7 @@ pip install asyncpg
111110

112111
## Usage
113112

114-
### Simple Code (get more example from ([example](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/tutorial/sample.py))
113+
### Simple Code (or see the longer ([example](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/tutorial/sample.py))
115114

116115

117116
```python
@@ -214,7 +213,7 @@ uvicorn.run(app, host="0.0.0.0", port=8000, debug=False)
214213
```
215214

216215
* Note:
217-
you can use [sqlacodegen](https://github.com/agronholm/sqlacodegen) to generate SQLAlchemy model for your table. This project is based on the model development and testing generated by sqlacodegen
216+
you can use [sqlacodegen](https://github.com/agronholm/sqlacodegen) to generate SQLAlchemy models for your table. This project is based on the model development and testing generated by sqlacodegen
218217

219218
### Main module
220219

0 commit comments

Comments
 (0)