Updated README

Author: ip2location

README.md

@@ -1,20 +1,43 @@
-IP2Proxy Java Component
-=======================
+# IP2Proxy Java Component
 
-This is the Java component to lookup IP2Proxy databases from https://www.ip2location.com/proxy-database
+This component allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
 
-IP2Proxy Database contains IP addresses which are used as VPN anonymizer, open proxies, web proxies and Tor exits. The database includes records for all public IPv4 addresses.
+* Free IP2Proxy BIN Data: http://lite.ip2location.com
+* Commercial IP2Proxy BIN Data: http://www.ip2location.com/proxy-database
 
+## Compilation
 
-Compilation
-===========
 ```bash
 javac com/ip2proxy/*.java
 jar cf ip2proxy.jar com/ip2proxy/*.class
 ```
 
-Sample Code
-===========
+## Methods
+Below are the methods supported in this class.
+
+|Method Name|Description|
+|---|---|
+|Open|Open the IP2Proxy BIN data for lookup. Please see the **Usage** section of the 2 modes supported to load the BIN data file.|
+|Close|Close and clean up the file pointer.|
+|GetPackageVersion|Get the package version (1 to 4 for PX1 to PX4 respectively).|
+|GetModuleVersion|Get the module version.|
+|GetDatabaseVersion|Get the database version.|
+|IsProxy|Check whether 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>|
+|GetAll|Return the proxy information in an object.|
+|GetProxyType|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|
+|GetCountryShort|Return the ISO3166-1 country code (2-digits) of the proxy.|
+|GetCountryLong|Return the ISO3166-1 country name of the proxy.|
+|GetRegion|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|
+|GetCity|Return the city name of the proxy.|
+|GetISP|Return the ISP name of the proxy.|
+
+## Usage
+
+Open and read IP2Proxy binary database. There are 2 modes:
+
+1. **IOModes.IP2PROXY_FILE_IO** - File I/O reading. Slower look, but low resource consuming. This is the default.
+2. **IOModes.IP2PROXY_MEMORY_MAPPED** - Stores whole IP2Proxy database into a memory-mapped file. Extremely resources consuming. Do not use this mode if your system do not have enough memory.
+
 ```java
 import com.ip2proxy.*;
 
@@ -37,7 +60,7 @@ public class Main {
 
 			String IP = "221.121.146.0";
 
-			if (Proxy.Open("/usr/data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.BIN", IP2Proxy.IOModes.IP2PROXY_MEMORY_MAPPED) == 0) {
+			if (Proxy.Open("/usr/data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.SAMPLE.BIN", IP2Proxy.IOModes.IP2PROXY_MEMORY_MAPPED) == 0) {
 				System.out.println("GetModuleVersion: " + Proxy.GetModuleVersion());
 				System.out.println("GetPackageVersion: " + Proxy.GetPackageVersion());
 				System.out.println("GetDatabaseVersion: " + Proxy.GetDatabaseVersion());