diff --git a/README.md b/README.md index b3c7929..61ded3e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ # akf-forum A Node.js based forum software + +## Installation +- Clone this repo. Or download it. +- Write `npm i` for install **dependencies** + +## Credits + +* [Akif9748](https://github.com/Akif9748) - Project owner +* [Camroku](https://github.com/Camroku) - Made stylesheets + + + +## To Do: +- Messsages will be record on a new database table, with reactions, by their ids. And it will be add statics. Threads will take messages from new table. +- Admin panel, etc. + +## Roadmap +- [ ] User + - [x] Login + - [x] Register + - [ ] Logout + - [ ] Admin +- [ ] Messages + - [x] Send message + - [ ] Delete message + - [ ] Edit message + - [ ] React message +- [ ] Forums + - [ ] Category system. + - [ ] Create category + - [ ] Delete category + - [ ] Edit category + - [ ] Move category +- [ ] Other + - [ ] API + - [ ] Other client for forum via API + +## Image: +![image](https://user-images.githubusercontent.com/70021050/155854448-76d3e030-3840-43e7-aa3a-80946a0a4ab5.png)