diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -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' +``` |