Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
pawelad committed Nov 20, 2016
1 parent 48e2644 commit 10121fb
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ every couple of hours, but I plan to fix in the near future.

## Installation
From PyPI:
```shell
$ pip install monzo
```
$ pip install monz
```

## Usage
Expand All @@ -29,7 +29,7 @@ To use the script you have to provide it with you Monzo
it as an environment variable (`$ export MONZO_ACCESS_TOKEN='...'`) or by
passing it explicitly with each command.

```shell
```
$ monz --help
Usage: monz [OPTIONS] COMMAND [ARGS]...
Expand All @@ -52,17 +52,18 @@ Commands:

## Examples
You can view your linked accounts:
```shell
```
$ monz accounts
Account #1, Bender Rodríguez
ID: acc_2716057
Created: Dec 31, 2999 11:59 PM
```

If you have only one then it will become the default one, but if you have more
then you have to pass it's ID explicitly to the rest of the commands.

You can view your current balance, which is also the default subcommand:
```shell
```
$ monz
Balance: £17.29
Spent today: £0.00
Expand All @@ -73,7 +74,7 @@ Spent today: £0.00
```

Lastly, you can see your latest transactions:
```shell
```
$ monz transactions -n 2
-£50.00 at Robot Arms Apartments (New New York)
Category: Bills
Expand Down

0 comments on commit 10121fb

Please sign in to comment.