From 4200768ef7741d74d7b4b777af5590c3650a8f12 Mon Sep 17 00:00:00 2001
From: jvech <jmvalenciae@unal.edu.co>
Date: Tue, 30 Apr 2024 10:33:05 -0500
Subject: doc: Documentation improved

---
 README.md | 26 +++++++++++++++++---------
 1 file changed, 17 insertions(+), 9 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e70b91f..fefc0fd 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,23 @@
 # Debt
 A debt recorder, which helps to remember who owns you money
 
+## Usage
+
+```
+Usage: debt [OPTIONS] <COMMAND>
+
+Commands:
+  init      Initialize Database
+  register  Register a transaction
+  view      View Registered data
+  add       Add a new agent to lend or pay
+  help      Print this message or the help of the given subcommand(s)
+
+Options:
+  -d, --database-path <DATABASE_PATH>  file path where data is stored [default: $XDG_DATA_HOME/debt/debt.db [env: DEBT_DB=]
+  -h, --help                           Print help
+  -V, --version                        Print version
+```
 
 ## Database
 
@@ -21,12 +38,3 @@ CREATE TABLE Registers (
     FOREIGN KEY(agent_id) REFERENCES Agents(id)
     )
 ```
-
-## Client
-
-```
-Usage:
-    debt action [options]
-```
-
-## Server
-- 
cgit v1.2.3-70-g09d2