diff --git a/README.md b/README.md index 1923488..68705eb 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ - [Manually](#manually) - [Documentation and Usage](#documentation-and-usage) - [Stack](#stack) +- [Roadmap](#roadmap) - [License](#license) ## Introduction @@ -55,6 +56,8 @@ _SimpleRESTBlog_ is a fast, fully async and reliable blog system RESTful API built with Python and [FastAPI] framework. It uses the open source [PostgreSQL] database for storage. +**Note**: This project is under development and is not fully ready! see the [Roadmap](#roadmap) section. + ## Features - Fully async and non-blocking. @@ -280,6 +283,16 @@ Frameworks and technologies used in _Shortify_ - [pre-commit] (Git hook) - [ruff] (Linter & Formatter) +## Roadmap +- [ ] Implement a route to `unpublish` a post +- [ ] Use [Redis] for page caching +- [ ] Introduce likes in _SRB_ +- [ ] Implement following and follower machnism +- [ ] Introduce notifications in _SRB_ + - [ ] notif for adding comments and replies + - [ ] notif for likes + - [ ] follow or unfollow + ## License This project is licensed under the terms of the [GPL-3.0] license.