Skip to content
This repository was archived by the owner on Jan 22, 2023. It is now read-only.

Commit e07534d

Browse files
authored
Update README.md
1 parent a5f2c60 commit e07534d

File tree

1 file changed

+29
-17
lines changed

1 file changed

+29
-17
lines changed

README.md

+29-17
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
# CHANGELOG
2-
**Improvements**:
3-
* can now get information on an individual company, including company officer's information
4-
* added flag <code>-n/--company-number</code> ;used for specifying which company to get information on
5-
* added flag <code>-j/--jurisdiction-code</code> ;used for specifying which jurisdiction code to check (recommended: should be used with <code>-n/--company-number</code>)
6-
* bug fixes
7-
81
# Unofficial Open Corporates CLI
92

103
![occli](https://user-images.githubusercontent.com/74001397/137996387-d7f23e1b-395e-499e-8d4d-250d25cca115.jpg)
@@ -23,52 +16,71 @@ This is an unofficial open corporates command line client.*
2316
# Installation
2417
**Clone From Github**:
2518
```
26-
$ git clone https://github.com/rlyonheart/occli.git
19+
git clone https://github.com/rlyonheart/occli.git
20+
21+
cd occli
22+
```
2723

28-
$ cd occli
24+
```
25+
pip install -r requirements.txt
2926
```
3027

28+
3129
**Install From PyPI**:
3230
```
33-
$ pip install occli
31+
pip install occli
3432
```
3533

3634
**Upgrade to latest version**:
3735
```
38-
$ python -m pip install --upgrade occli
36+
python -m pip install --upgrade occli
3937
```
4038

4139

4240
# Usage
4341
**Github Clone**:
4442
```
45-
$ python occli -c COMPANY-NAME
43+
python occli -c COMPANYNAME
4644
```
4745

4846
**Viewing API version information**:
4947
```
50-
$ python occli --versions
48+
python occli --versions
49+
```
50+
51+
**Alternatively**:
52+
```
53+
chmod +x occli
5154
```
5255

56+
```
57+
occli -c COMPANYNAME
58+
```
59+
60+
```
61+
occli --versions
62+
```
63+
64+
5365
**Getting information on an individual company**:
5466
```
55-
$ python occli -n COMPANY-NUMBER -j JURISDICTION-CODE
67+
occli -n COMPANYNUMBER -j JURISDICTIONCODE
5668
```
5769

5870

5971
**PyPI Package**:
6072
```
61-
$ occli -c COMPANY-NAME
73+
occli -c COMPANYNAME
6274
```
6375

6476
**Viewing version information**
6577
```
66-
$ occli --versions
78+
occli --versions
6779
```
6880

6981
**Getting information on an individual company**:
7082
```
71-
$ occli -n COMPANY-NUMBER -j JURISDICTION-CODE
83+
occli -n COMPANYNUMBER -j JURISDICTIONCODE
7284
```
7385

7486
# Optional Arguments

0 commit comments

Comments
 (0)