Skip to content

Commit d2ce8ad

Browse files
peter simpsonpeter simpson
authored andcommitted
REDME improvements
1 parent 9a405a7 commit d2ce8ad

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

.idea/clidat.iml

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,26 @@ whilst the output of the different commands is passed to
77
a TUI from the [Pyfx](https://github.com/cielong/pyfx) package.
88

99
I work in support at Codat, and have built this tool as a personal project
10-
to use as part of my day-job. This isnt an officially
10+
to help with my day-job. This isn't an officially
1111
supported product.
1212

1313
## Installation
1414

15-
CLIdat is distributed via the Python Package Index (PyPI).
15+
CLIdat is distributed via the Python Package Index (PyPI). We reccomend installing
16+
it inside a [virtual environment](https://docs.python.org/3/library/venv.html)
1617

1718
```console
18-
pip install clidat
19+
(venv) user@host:~$pip install clidat
1920
```
20-
This software will only work on MacOS or Linux
21+
This software will only work on MacOS or Linux. Cygwin and WSL do not yield good results, either.
2122

2223
## Quick Start
2324

2425
```console
25-
user@host:~$ clidat auth
26+
(venv) user@host:~$ clidat auth
2627
Your Codat API Key:
2728

28-
user@host:~$ clidat get-companies
29+
(venv) user@host:~$ clidat get-companies
2930
```
3031
![Clidat Get Companies](./clidat_get_companies_image.png)
3132

@@ -34,7 +35,7 @@ user@host:~$ clidat get-companies
3435

3536
To see a list of all avaliable commands run:
3637
```console
37-
user@host:~$ run clidat --help
38+
(venv) user@host:~$ run clidat --help
3839

3940
auth
4041
get-account
@@ -47,7 +48,7 @@ To get details on a particular command, just append the --help
4748
flag onto the end of the command, for example:
4849

4950
```console
50-
user@host:~$ clidat get-payment --help
51+
(venv) user@host:~$ clidat get-payment --help
5152
Options:
5253
--payment TEXT [required]
5354
-id, --company-id TEXT [required]

0 commit comments

Comments
 (0)