Skip to content

Commit 59a30f8

Browse files
peter simpsonpeter simpson
authored andcommitted
readme improvements
1 parent cdb8038 commit 59a30f8

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ CLIdat is a tool for inspecting Data from Codat.
44

55
The Command Line Interface itself is written with [Click](https://github.com/pallets/click),
66
whilst the output of the different commands is passed to
7-
a TUI from the [Pyfx](https://github.com/cielong/pyfx) package.
7+
a TUI from the [Textual](https://github.com/Textualize/textual) package.
88

99
I work in support at Codat, and have built this tool as a personal project
1010
to help with my day-job. This isn't an officially
@@ -18,17 +18,18 @@ it inside a [virtual environment](https://docs.python.org/3/library/venv.html)
1818
```console
1919
(venv) user@host:~$ pip install clidat
2020
```
21-
This software will only work on MacOS or Linux. Cygwin and WSL do not yield good results, either.
21+
Thanks to Textual, this software is cross-platform and
22+
should work well on Windows, Linux and MacOS.
2223

2324
## Quick Start
2425

2526
```console
2627
(venv) user@host:~$ clidat auth
2728
Your Codat API Key:
2829

29-
(venv) user@host:~$ clidat get-companies
30+
(venv) user@host:~$ clidat get-suppliers -id 2e14de3b-e2cf-4745-af24-a9a082b4c466
3031
```
31-
![Clidat Get Companies](./clidat_get_companies_image.png)
32+
![Clidat Get Companies](./clidat_get_suppliers_image.png)
3233

3334

3435
## Docs
@@ -52,8 +53,10 @@ flag onto the end of the command, for example:
5253
Options:
5354
--payment TEXT [required]
5455
-id, --company-id TEXT [required]
56+
-j, --json View plain JSON response
5557
--help Show this message and exit.
5658

5759

60+
5861
```
5962

clidat_get_companies_image.png

-117 KB
Binary file not shown.

clidat_get_suppliers_image.png

82.5 KB
Loading

0 commit comments

Comments
 (0)