aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjvech <jmvalenciae@unal.edu.co>2024-05-03 11:23:01 -0500
committerjvech <jmvalenciae@unal.edu.co>2024-05-03 11:23:01 -0500
commit818104a99c18834c10a685a8f06c21a41feec356 (patch)
treeff046286ab0978d033c3b84cab4a48b4582b9ac4 /README.md
parent4200768ef7741d74d7b4b777af5590c3650a8f12 (diff)
doc: Improve README file
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index fefc0fd..ddfc3be 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# Debt
+
A debt recorder, which helps to remember who owns you money
## Usage
@@ -38,3 +39,20 @@ CREATE TABLE Registers (
FOREIGN KEY(agent_id) REFERENCES Agents(id)
)
```
+
+## Examples
+Add a new debtor:
+
+```
+debt add 'Jane Doe'
+```
+
+Borrow 1000 (dollars, euros or whatever) to Jane Doe:
+```
+debt register 'Jane Doe' 1000 'Some optional note'
+```
+
+Register a payment of 50 (of any exchange) from Jane Doe:
+```
+debt register -p 'Jane Doe' 50 'Another optional note'
+```
Feel free to download, copy and edit any repo