Skip to content

Commit e158136

Browse files
committed
Update README.md
1 parent 433608b commit e158136

File tree

1 file changed

+2
-60
lines changed

1 file changed

+2
-60
lines changed

README.md

Lines changed: 2 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,8 @@ 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-
## Installation
13-
14-
### Unix/Linux
15-
autoreconf -i -v --force
16-
./configure
17-
make
18-
19-
### Windows
20-
Execute "vcvarsall.bat". (This file is part of Microsoft Visual C, not ip2location code)
21-
nmake -f Makefile.win
22-
23-
### MacOS
24-
autoreconf -i -v --force
25-
export CFLAGS=-I/usr/include/malloc
26-
./configure
27-
make
12+
## Developer Documentation
13+
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)
2814

2915
## Testing
3016

@@ -36,50 +22,6 @@ For more details, please visit:
3622
* Download free IP2Proxy LITE databases at [https://lite.ip2location.com](https://lite.ip2location.com)
3723
* Download IP2Proxy sample databases at [https://www.ip2location.com/ip2proxy/developers](https://www.ip2location.com/ip2proxy/developers)
3824

39-
## Methods
40-
41-
Below are the methods supported in this library.
42-
43-
| Method Name | Description |
44-
| ---------------------------------------------------- | ------------------------------------------------------------ |
45-
| IP2Proxy_open | Open the IP2Proxy BIN data with **File I/O** mode for lookup. |
46-
| IP2Proxy_open_csv | Open the IP2Proxy CSV file for lookup. Slower performance. |
47-
| IP2Proxy_open_mem\|IP2Proxy_set_lookup_mode | Open the IP2Proxy BIN data with **Shared Memory** or **Memory Cache** mode to speed up lookup. |
48-
| IP2Proxy_close | Close and clean up the file pointer. |
49-
| IP2Proxy_get_package_version | Get the package version (1 to 4 for PX1 to PX8 respectively). |
50-
| IP2Proxy_get_module_version\|IP2Proxy_version_string | Get the module version. |
51-
| IP2Proxy_get_database_version | Get the database version. |
52-
| IP2Proxy_is_proxy | Check wether if an IP address was a proxy. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address</li></ul> |
53-
| IP2Proxy_get_all | Return the proxy information in array. |
54-
| IP2Proxy_get_proxy_type | Return the proxy type. Please visit <a href="https://www.ip2location.com/databases/px4-ip-proxytype-country-region-city-isp" target="_blank">IP2Location</a> for the list of proxy types supported |
55-
| IP2Proxy_get_country_short | Return the ISO3166-1 country code (2-digits) of the proxy. |
56-
| IP2Proxy_get_country_long | Return the ISO3166-1 country name of the proxy. |
57-
| IP2Proxy_get_region | Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported |
58-
| IP2Proxy_get_city | Return the city name of the proxy. |
59-
| IP2Proxy_get_isp | Return the ISP name of the proxy. |
60-
| IP2Proxy_get_domain | Return internet domain name associated with IP address range. |
61-
| IP2Proxy_get_usage_type | Return usage type classification of ISP or company. |
62-
| IP2Proxy_get_asn | Return autonomous system number (ASN). |
63-
| IP2Proxy_get_as | Return autonomous system (AS) name. |
64-
| IP2Proxy_get_last_seen | Return proxy last seen in days. |
65-
| IP2Proxy_get_threat | Return security threat reported. |
66-
| IP2Proxy_get_provider | Return name of VPN provider if available. |
67-
68-
69-
70-
## Usage
71-
72-
Open and read IP2Proxy binary database. There are 3 modes:
73-
74-
1. IP2Proxy_open("SAMPLE.BIN") - File I/O reading. Slower look, but low resource consuming.
75-
2. IP2Proxy_open_csv("SAMPLE.CSV") - CSV parsing. Slowest, but convenient to use.
76-
3. IP2Proxy_set_lookup_mode(IP2ProxyObj, IP2PROXY_SHARED_MEMORY) - Stores whole IP2Proxy database into system memory. Lookup is possible across all applications within the system. Extremely resources
77-
consuming. Do not use this mode if your system do not have enough
78-
memory.
79-
4. IP2Proxy_set_lookup_mode(IP2ProxyObj, IP2PROXY_CACHE_MEMORY) - Caches database into memory for faster lookup. Required high memory.
80-
81-
82-
8325
## Support
8426

8527

0 commit comments

Comments
 (0)