Skip to content

Commit

Permalink
add roadmap to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mahdihaghverdi committed Apr 29, 2024
1 parent 6739eed commit 88674fe
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,16 @@
- [Manually](#manually)
- [Documentation and Usage](#documentation-and-usage)
- [Stack](#stack)
- [Roadmap](#roadmap)
- [License](#license)

## Introduction

_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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 88674fe

Please sign in to comment.