officereso/budget
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme with correct spacing

Browse Source
This commit is contained in:
Quentin Snow 2023-01-17 13:42:09 -06:00
parent b6967e665e
commit ea057e7401
2 changed files with 38 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,7 +1,6 @@
Output of budget.
```
Usage:
budget <action> [options] ...
Actions:
-h --help Prints this.
@ -20,22 +19,19 @@ Earn Options: -v [-drD]
-v --value=<FlOAT> Value for earning.
-d --description=<STRING> Description for earning.
-r --receipt=<PATH> Path to file to store in DB as receipt.
-D --date=<dd/mm/yyyy> Date as dd/mm/yyyy. Default will be today.
-t --time=<hh/mm/ss> 24 hour time as hh/mm/ss. Default will be now.
-D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today.
Payment Options: -v [-drD]
-v --value=<FlOAT> Value for payment.
-d --description=<STRING> Description for payment.
-r --receipt=<PATH> Path to file to store in DB as receipt.
-D --date=<NUM/NUM/NUM> Date as dd/mm/yyyy. Default will be today.
-t --time=<hh/mm/ss> 24 hour time as hh/mm/ss. Default will be now.
-D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today.
```
Arguments are processed like blocks with each one terminated by the next Action. For example
```
budget -cAcct -eAcct -v10.00 -r"./receipt.pdf" -pAcct -v5.50 -r"./payment.pdf"
```
````
Does the following in order:
1. Creates an account named ``Acct`` with no description.
2. Earns ``10.00`` to it with a receipt.
3. Pays ``5.50`` to it with a receipt.
Creates an account named Acct with no description.
Earns 10.00 to it with a receipt.
Pays 5.50 to it with a receipt.