From 60e80a5c39b83e321a2fc83cb429c33fbcb73f00 Mon Sep 17 00:00:00 2001 From: svaponi <10941963+svaponi@users.noreply.github.com> Date: Sun, 21 Jul 2024 15:23:40 +0200 Subject: [PATCH] task: update docs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fe5c141..2f10cf9 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,11 @@ [![Test](https://github.com/svaponi/fastapi-mongodb-boilerplate/actions/workflows/run-tests.yml/badge.svg)](https://github.com/svaponi/fastapi-mongodb-boilerplate/actions/workflows/run-tests.yml) [![Coverage Status](https://coveralls.io/repos/github/svaponi/fastapi-mongodb-boilerplate/badge.svg?branch=main)](https://coveralls.io/github/svaponi/fastapi-mongodb-boilerplate?branch=main) -Boilerplate repository to kickstart 🚀 your [FastAPI](https://fastapi.tiangolo.com/) project. +Boilerplate repository to kickstart 🚀 your [FastAPI](https://fastapi.tiangolo.com/) + [MongoDB](https://www.mongodb.com/) project. ### Key features +- **Non-blocking**, based on [Motor (async driver for MongoDB)](https://www.mongodb.com/docs/drivers/motor/). - Run [pytest](https://docs.pytest.org/) when you **push changes to `src/` dir** ([GitHub Actions](/.github/workflows/run-tests.yml)). - [Poetry](https://python-poetry.org/docs/#installation) as **dependency manager** and **packaging tool**. - [Coveralls](https://docs.coveralls.io/) integration (for coverage badge).