diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..4ebf70b7e9a0d5debc48fa724c8f520fe0846552 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +<div align="center"> +<img src="images/logo.png" width=700> +<div><i>Fast and flexible general-purpose template for your API.</i></div> +</div> + +## Usage + +```bash +python3 -m pip install cookiecutter +cookiecutter gh:s3rius/FastAPI-template +# Answer prompts questions +# ??? +# 🪠Enjoy your new project 🪠+``` + +## Features +Currently supported features: +- redis +- systemd units +- Example (dummy) SQLAlchemy model +- Elastic Search support +- Scheduler support + +Planned features: +- Add Makefile support \ No newline at end of file diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9ef8a28ef331536e7408e3409196c5441736d142 Binary files /dev/null and b/images/logo.png differ