From 818104a99c18834c10a685a8f06c21a41feec356 Mon Sep 17 00:00:00 2001 From: jvech Date: Fri, 3 May 2024 11:23:01 -0500 Subject: doc: Improve README file --- Cargo.toml | 2 +- README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index f6c417d..233bfe2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "debt" -version = "0.2.0" +version = "0.2.1" edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 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' +``` -- cgit v1.2.3-70-g09d2