From c8490bd8037fc62e15f6d97a5ad8bdb0520b9aae Mon Sep 17 00:00:00 2001
From: Ruidy <ruidy.nemausat@gmail.com>
Date: Fri, 15 Nov 2024 10:20:07 +0100
Subject: [PATCH] improve readme

---
 README.md | 43 +++++++++++++++++++++++++++++--------------
 1 file changed, 29 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index e7e2ea6..df22e05 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,19 @@
 # Rentease
 
-<div align="center">
-  <a href="https://github.com/rjnemo/rentease">
-    <img src="assets/icons/favicon-main.png" alt="Logo" width="80" height="80">
-  </a>
-</div>
+![RentEase](assets/icons/favicon-main.png)
+
+<!--toc:start-->
+
+- [Rentease](#rentease)
+    - [Features](#features)
+    - [Getting Started](#getting-started)
+        - [Prerequisites](#prerequisites)
+        - [Installation](#installation)
+        - [Built With](#built-with)
+    - [Roadmap](#roadmap)
+    - [Contributing](#contributing)
+    - [License](#license)
+  <!--toc:end-->
 
 Rentease is a property-management application to help landlords to manage your rental
 properties efficiently. With Rentease, you can create invoices, generate activity
@@ -12,9 +21,12 @@ reports, and sync all the booking platforms you use.
 
 ## Features
 
-- **Invoice Management**: Create and manage invoices for your rental properties with ease.
-- **Activity Reports**: Generate detailed reports of rental activities to keep track of your property performance.
-- **Platform Sync**: Sync bookings across multiple platforms to streamline your rental management.
+- **Invoice Management**: Create and manage invoices for your rental properties
+  with ease.
+- **Activity Reports**: Generate detailed reports of rental activities to keep track
+  of your property performance.
+- **Platform Sync**: Sync bookings across multiple platforms to streamline your rental
+  management.
 
 [![RentEase Screenshot][product-screenshot]](https://example.com)
 
@@ -27,14 +39,14 @@ To get started with Rentease, follow these steps.
 You need a version of the Go programming language installed. You can either install
 it via your package manager or via [Go's official website](https://go.dev/).
 You also need a PostgreSQL database. You can install it locally using Homebrew or
-use a cloud alternative such as Railway, fly.io, _etc._.
+use a cloud alternative such as Railway, fly.io, _etc._
 
 ### Installation
 
 1. Clone the repository
 
    ```sh
-   git clone https://github.com/yourusername/rentease.git
+   git clone https://github.com/rjNemo/rentease.git
    cd rentease
    ```
 
@@ -54,7 +66,7 @@ use a cloud alternative such as Railway, fly.io, _etc._.
 4. **Configure the application**:
    Create a `.env` file in the project root with the following environment variables:
 
-   ```env
+   ```sh
    DB_HOST=localhost
    DB_PORT=5432
    DB_USER=your_db_username
@@ -75,11 +87,14 @@ use a cloud alternative such as Railway, fly.io, _etc._.
 
 Rentease is built using the following technologies:
 
-- [Go](https://go.dev/): The core application logic is written in Go, providing a robust and efficient backend.
-- [Htmx](https://htmx.org/): For handling AJAX requests and enhancing the user interface with minimal JavaScript.
+- [Go](https://go.dev/): The core application logic is written in Go, providing a
+  robust and efficient backend.
+- [Htmx](https://htmx.org/): For handling AJAX requests and enhancing the user interface
+  with minimal JavaScript.
 - [Templ](https://templ.guide/): Used for templating and rendering dynamic HTML content.
 - [Gorm](https://gorm.io/docs): An ORM library for Go, used for database interactions.
-- [PostgreSQL](https://www.postgresql.org/):The database used to store all application data.
+- [PostgreSQL](https://www.postgresql.org/):The database used to store all application
+  data.
 
 ## Roadmap