Skip to content

Commit 65448dc

Browse files
committed
docs: Update README with thesis status and future development plans
1 parent 6866444 commit 65448dc

1 file changed

Lines changed: 8 additions & 17 deletions

File tree

README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,15 @@
1-
# Work in progress | Breaking changes expected
1+
# I am currently working on my master's thesis.
22

3-
This project was generated using fastapi_template.
3+
## Work in progress | Breaking changes expected
44

5-
## Poetry
5+
### Future plans:
6+
- Add caching with Redis
7+
- Refactor integration with Taskiq
8+
- Rework documentation
9+
- Add metrics with OpenTelemetry and Grafana
10+
- Add interactive demo
611

7-
This project uses poetry. It's a modern dependency management
8-
tool.
912

10-
To run the project use this set of commands:
11-
12-
```bash
13-
poetry install
14-
poetry run python -m app
15-
```
16-
17-
This will start the server on the configured host.
18-
19-
You can find swagger documentation at `/api/docs`.
20-
21-
You can read more about poetry here: https://python-poetry.org/
2213

2314
## Docker
2415

0 commit comments

Comments
 (0)