From de17cf44ec5260305de8aa053582744ec69d705f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Elisi=C3=A1rio=20Couto?= <elisiario@couto.io>
Date: Mon, 19 Feb 2024 00:53:56 +0000
Subject: [PATCH] docs: Improve README.md.

---
 README.md | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index f8d8c8a..3c44c3d 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,34 @@
-# leggen
+# 💲 leggen
 
 An Open Banking CLI.
 
-## Features
+This tool aims to provide a simple way to connect to banks using the GoCardless Open Banking API.
+
+Having a simple CLI tool to connect to banks and list transactions can be very useful for developers and companies that need to access bank data.
+
+Having your bank data in a database, gives you the power to backup, analyze and create reports with your data.
+
+## 🛠️ Technologies
+  - Python: for the CLI
+  - [GoCardless Open Banking API](https://developer.gocardless.com/bank-account-data/overview): for connecting to banks
+  - [MongoDB](https://www.mongodb.com/docs/): for storing transactions, good balance between performance and query capabilities
+  - [Ofelia](https://github.com/mcuadros/ofelia): for scheduling regular syncs with the database when using Docker
+
+## ✨ Features
   - Connect to banks using GoCardless Open Banking API
   - List all connected banks and their status
   - List balances of all connected accounts
   - List transactions for an account
   - Sync all transactions with a MongoDB database
 
-## Installation and Configuration
+## 🚀 Installation and Configuration
 
 In order to use `leggen`, you need to create a GoCardless account. GoCardless is a service that provides access to Open Banking APIs. You can create an account at https://gocardless.com/bank-account-data/.
 
 After creating an account and getting your API keys, the best way is to use the [compose file](docker-compose.yml). Open the file and adapt it to your needs. Then run the following command:
 
 ```bash
-$ docker-compose up -d
+$ docker compose up -d
 ```
 
 The leggen container will exit, this is expected. Now you can run the following command to create the configuration file:
@@ -37,7 +49,7 @@ To sync all transactions with the database, run the following command:
 $ docker compose run leggen sync
 ```
 
-## Usage
+## 👩‍🏫 Usage
 
 ```
 $ leggen --help
@@ -60,5 +72,5 @@ Commands:
   transactions  List transactions for an account
 ```
 
-## Caveats
+## ⚠️ Caveats
   - This project is still in early development.