aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjvech <jmvalenciae@unal.edu.co>2024-04-30 10:33:05 -0500
committerjvech <jmvalenciae@unal.edu.co>2024-04-30 10:33:05 -0500
commit4200768ef7741d74d7b4b777af5590c3650a8f12 (patch)
treee4d5180459aeaa287f7834baf7efb3c41e0faaed
parentce3bbcd183bcf505b525396db3ba4b9e71c83f55 (diff)
doc: Documentation improved
-rw-r--r--README.md26
1 files changed, 17 insertions, 9 deletions
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
Feel free to download, copy and edit any repo