some tweaks and readme

README.md

@@ -7,31 +7,81 @@ Short description or introduction of your project.
 - [About](#about)
 - [Features](#features)
 - [Installation](#installation)
-- [Usage](#usage)
-- [Contributing](#contributing)
 - [License](#license)
 - [Creators](#creators)
 - [Contact](#contact)
 
 ## About
 
-Detailed information about the project, its purpose, goals, and any relevant background.
+This is the backend for a forum you can self host. It is written in NodeJS and uses the Surrealdb database. It is a REST API that uses JSON for communication. It is uses the Express framework. Further it uses the following packages:
+
+- auth-guardian: "^1.1.1",
+- cookie-parser: "^1.4.6",
+- cors": "2.8.5",
+- dotenv: "^16.3.1",
+- express: "^4.18.2",
+- jsonwebtoken: "^9.0.2",
+- surrealdb.node: "^0.3.0"
+
+The frontend will be written in NextJS and will be a seperate repository.
+This project is under development and is not ready for production.
 
 ## Features
 
-Highlight key features or functionalities of the project.
+- [x] User authentication
+- [x] User registration
+- [x] User login
+- [x] User logout
+- [x] User profile
+- [x] User profile update
+- [x] User profile delete
+- [x] Create post
+- [x] Like post
+- [x] Comment on post
+- [x] Save post
+- [x] Comment on comment
+- [x] Like comment
+- [x] Save comment
+- [x] Search posts
+- [x] Search users
+- [x] Trending posts
+- [x] Most active users
+- [x] Most liked posts
+- [x] Most commented posts
+- [x] Most saved posts
 
 ## Installation
 
-Step-by-step instructions on how to install or set up the project. Include any prerequisites or dependencies.
+### Prerequisites
+NodeJS and NPM are required to run this project. You can download them [here](https://nodejs.org/en/download/).
 
-## Usage
+### Clone
 
-Examples, code snippets, or instructions on how to use the project. Showcasing different use cases can be beneficial.
+Clone this repository to your local machine using
 
-## Contributing
+```shell
+git clone https://gitea.quiztimes.nl/kajvans/forum-backend.git
+```
 
-Guidelines for contributing to the project. Include information on how to report issues, suggest improvements, or submit pull requests.
+### Setup
+
+Edit .env.example and rename it to .env. Fill in the required information.
+
+### Install dependencies
+
+Install the required dependencies using
+
+```shell
+npm install
+```
+
+### Running
+
+Run the project using
+
+```shell
+npm start
+```
 
 ## License