Skip to content

Commit 6c19eb7

Browse files
committed
chg: Update doc
1 parent b449a16 commit 6c19eb7

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,18 @@ pip install pymmdbserver
1616
You can use the `mmdbserver` command to query the MMDB Server from the command line.:
1717

1818
```bash
19+
usage: mmdbserver [-h] [--url URL] [ip]
20+
21+
Query a thing.
22+
23+
positional arguments:
24+
ip IP address to query. If not set, returns the geolookup information from the client IP.
25+
26+
options:
27+
-h, --help show this help message and exit
28+
--url URL URL of the instance.
1929
```
2030

2131
### Library
2232

23-
See [API Reference]()
33+
See [API Reference](https://pymmdbserver.readthedocs.io/en/latest/api_reference.html)

docs/source/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ Usage
2222
You can use `mmdbserver` as a python script::
2323

2424
$ mmdbserver -h
25+
usage: mmdbserver [-h] [--url URL] [ip]
26+
27+
Query a thing.
28+
29+
positional arguments:
30+
ip IP address to query. If not set, returns the geolookup information from the client IP.
31+
32+
options:
33+
-h, --help show this help message and exit
34+
--url URL URL of the instance.
2535

2636
Or as a library:
2737

0 commit comments

Comments
 (0)