From 8628c375ec9a743103a2f4de38861a3f25395249 Mon Sep 17 00:00:00 2001 From: zevav Date: Wed, 30 Oct 2019 15:21:43 +0100 Subject: [PATCH] readme --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2cfc5a3..39d0161 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Personal API -Make a secured web API that stores and serves up your own personal and professional data! -As of the current commit, it's oriented towards powering freelancers' websites. +Make a secured web API that stores and serves up your data! +The current schema is oriented towards powering freelancers' websites. ## Installation @@ -64,4 +64,17 @@ As of today the available endpoints are title: str description: str link: str (optional) -``` \ No newline at end of file +``` + +## Dependencies + +This project relies on the excellent work of +[SQLALchemy](https://www.sqlalchemy.org/), +[Pydantic](https://github.com/samuelcolvin/pydantic/), +[FastAPI](https://fastapi.tiangolo.com/), +[Pytest](https://docs.pytest.org/en/latest/contents.html), +and [Starlette](https://www.starlette.io/) + +## Why? + +It started as an excuse to get acquainted with FastAPI, as well as to make a front-end first (JAMstack?) personal site.