diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
index f29ed0e..eced56e 100644
--- a/.github/workflows/python-app.yml
+++ b/.github/workflows/python-app.yml
@@ -19,6 +19,9 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
+ - name: Lint commit messages
+ uses: wagoid/commitlint-github-action@v6
+
- name: Set up Python ${{ env.PYTHON_VERSION }}
uses: actions/setup-python@v5
with:
diff --git a/README.md b/README.md
index 202888a..9e014a2 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
## Manifesto
-> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — Linus Torvalds
+> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — [Linus Torvalds](https://web.archive.org/web/20050404020308/http://www.linuxtimes.net/modules.php?name=News&file=article&sid=145)
## About
@@ -19,9 +19,9 @@ Proof of Concept for a RESTful API made with [Python 3](https://www.python.org/)
## Structure
-The following is a simplified dependency diagram of modules and main libraries:
+
-
+_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._
## Install
@@ -43,7 +43,7 @@ uvicorn main:app --reload --port 9000
http://localhost:9000/docs
```
-
+
## Credits
diff --git a/assets/images/python-samples-fastapi-restful.svg b/assets/images/python-samples-fastapi-restful.svg
deleted file mode 100644
index 649c715..0000000
--- a/assets/images/python-samples-fastapi-restful.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/assets/images/structure.svg b/assets/images/structure.svg
new file mode 100644
index 0000000..2caf9c4
--- /dev/null
+++ b/assets/images/structure.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/assets/images/python-samples-fastapi-restful-docs.png b/assets/images/swagger.png
similarity index 100%
rename from assets/images/python-samples-fastapi-restful-docs.png
rename to assets/images/swagger.png