Skip to content

Commit

Permalink
Fix small typos in README.md + add .idea/ to .gitignore (#4)
Browse files Browse the repository at this point in the history
* Add .idea/ to .gitignore

* Fix small typos in readme
  • Loading branch information
ivanPrunier authored Feb 17, 2024
1 parent 81fac60 commit 5e557b0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,6 @@ database.db
*migration.py
.python-version
.DS_Store
.nicegui/
.nicegui/

.idea/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
Full [Documentation](https://paperz-org.github.io/blitz/) here.

# **What is Blitz ?**
Blitz is a tool that build restfull API on the fly based on a simple and easy to maintain configuration file.
Blitz is a tool that builds restfull APIs on the fly based on a simple and easy to maintain configuration file.

Here is an example of how simple a Blitz file is:
```yaml
Expand Down Expand Up @@ -60,7 +60,7 @@ blitz start your-blitz-app

*And yeah, that's it.*

Just add some resources in the blitz file, and you have now a fully functional API with models and the corresponding database schema with all the modern feature you can expect from a modern app like:
Just add some resources in the blitz file, and you now have a fully functional API with models and the corresponding database schema, along with all the modern features you can expect from a modern app like:

- Automatic Swagger UI for the API
- Admin
Expand Down

0 comments on commit 5e557b0

Please sign in to comment.