Skip to content

Commit cab904a

Browse files
committed
Update readme.md
1 parent d284564 commit cab904a

File tree

1 file changed

+2
-25
lines changed

1 file changed

+2
-25
lines changed

readme.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,9 @@ This library allows user to query an IP address if it was being used as open pro
55
- Free IP2Proxy BIN Data: [https://lite.ip2location.com](https://lite.ip2location.com/)
66
- Commercial IP2Proxy BIN Data: https://www.ip2location.com/proxy-database
77

8-
## Requirement
8+
## Developer Documentation
9+
To learn more about installation, usage, and code examples, please visit the developer documentation at [https://ip2proxy-r.readthedocs.io/en/latest/index.html.](https://ip2proxy-r.readthedocs.io/en/latest/index.html)
910

10-
IP2Proxy R package required IP2Proxy Python library to work. In order to install IP2Proxy Python library, you can use the following command:
11-
12-
```Python
13-
pip install IP2Proxy
14-
```
15-
16-
## Installation
17-
18-
1. In your RStudio IDE, type the following command into the console:
19-
20-
```R
21-
install.packages("devtools")
22-
require(devtools)
23-
```
24-
25-
2. After that, install IP2Proxy R package by using the following command: `install_github("ip2location/ip2proxy-r")`
26-
27-
## Usage
28-
29-
1. Load IP2Proxy BIN database by the following command: `ip2proxy::open(path_to_your_database)`
30-
2. Query all the proxy information for an IP address by this command: `ip2proxy::get_all(ip_address)`
31-
3. To know whether an IP address is a proxy or not, you can do this by: `ip2proxy::is_proxy(ip_address)`
32-
4. Query the proxy information for an IP address using web service: `ip2proxy::lookup_web_service(your_api_key, ip_address, package)`
33-
5. To plot IP addresses on the map: ip2proxy::plot_map(c(list_of_ip_addresses))
3411

3512
## Proxy Type
3613

0 commit comments

Comments
 (0)