Skip to content

Commit d49f343

Browse files
committed
Added CLI usage instructions.
1 parent 347a603 commit d49f343

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,50 @@ You can access to the commercial databases from https://www.ip2location.com/prox
99
For more details, please visit:
1010
[http://www.ip2location.com/ip2proxy/developers/c](http://www.ip2location.com/ip2proxy/developers/c)
1111

12+
13+
1214
## Developer Documentation
15+
1316
To learn more about installation, usage, and code examples, please visit the developer documentation at [https://ip2proxy-c.readthedocs.io/en/latest/index.html.](https://ip2proxy-c.readthedocs.io/en/latest/index.html)
1417

18+
19+
1520
## Testing
1621

1722
cd test
1823
./test-IP2Proxy
1924

25+
26+
2027
## Sample BIN Databases
2128

2229
* Download free IP2Proxy LITE databases at [https://lite.ip2location.com](https://lite.ip2location.com)
2330
* Download IP2Proxy sample databases at [https://www.ip2location.com/ip2proxy/developers](https://www.ip2location.com/ip2proxy/developers)
2431

32+
33+
34+
## IP2Proxy CLI
35+
36+
Query an IP address and display the result
37+
38+
```
39+
ip2proxy -d [IP2PROXY BIN DATA PATH] --ip [IP ADDRESS]
40+
```
41+
42+
Query all IP addresses from an input file and display the result
43+
44+
```
45+
ip2proxy -d [IP2PROXY BIN DATA PATH] -i [INPUT FILE PATH]
46+
```
47+
48+
Query all IP addresses from an input file and display the result in XML format
49+
50+
```
51+
ip2proxy -d [IP2PROXY BIN DATA PATH] -i [INPUT FILE PATH] --format XML
52+
```
53+
54+
55+
2556
## Support
2657

2758

0 commit comments

Comments
 (0)