Skip to content

Commit

Permalink
docs: better README
Browse files Browse the repository at this point in the history
  • Loading branch information
woile committed Mar 30, 2024
1 parent 390396f commit 41fa69d
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,34 @@
This has been a [PyCamp.es](https://pycamp.es) 2024 project, use with discretion.

## Installation

```sh
pipx install ficamp
```

Alternatively:

```sh
pip install -U --user ficamp
```

## Usage

```terminal
$ ficamp --help
usage: ficamp [-h] [--bank {abn}] filename
Print the first argument from the CLI
positional arguments:
filename The spreadsheet to load
options:
-h, --help show this help message and exit
--bank {abn}
```

## Contributing

Read [CONTRIBUTING.md](./CONTRIBUTING.md).

0 comments on commit 41fa69d

Please sign in to comment.