Update README.md

Author: ip2location

README.md

@@ -8,159 +8,5 @@ This package allows user to query an IP address if it was being used as VPN anon
 * Free IP2Proxy BIN Data: https://lite.ip2location.com
 * Commercial IP2Proxy BIN Data: https://www.ip2location.com/database/ip2proxy
 
-As an alternative, this package can also call the IP2Proxy Web Service. This requires an API key. If you don't have an existing API key, you can subscribe for one at the below:
-
-https://www.ip2location.com/web-service/ip2proxy
-
-## Installation
-
-To install this module type the following:
-
-```bash
-
-go get github.com/ip2location/ip2proxy-go/v4
-
-```
-
-## QUERY USING THE BIN FILE
-
-## Methods
-Below are the methods supported in this package.
-
-|Method Name|Description|
-|---|---|
-|OpenDB|Open the IP2Proxy BIN data for lookup.|
-|Close|Close and clean up the file pointer.|
-|PackageVersion|Get the package version (1 to 11 for PX1 to PX11 respectively).|
-|ModuleVersion|Get the module version.|
-|DatabaseVersion|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 or search engine robot</li></ul>|
-|GetAll|Return the proxy information in an array.|
-|GetProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/database/px10-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen-threat-residential" 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.|
-|GetDomain|Return the domain name of the proxy.|
-|GetUsageType|Return the usage type classification of the proxy. Please visit <a href="https://www.ip2location.com/database/px10-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen-threat-residential" target="_blank">IP2Location</a> for the list of usage types supported.|
-|GetAsn|Return the autonomous system number of the proxy.|
-|GetAs|Return the autonomous system name of the proxy.|
-|GetLastSeen|Return the number of days that the proxy was last seen.|
-|GetThreat|Return the threat type of the proxy.|
-|GetProvider|Return the provider of the proxy.|
-
-## Usage
-
-```go
-package main
-
-import (
-	"fmt"
-	"strconv"
-	"github.com/ip2location/ip2proxy-go/v4"
-)
-
-func main() {
-	db, err := ip2proxy.OpenDB("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER.BIN")
-	
-	if err != nil {
-		return
-	}
-	ip := "199.83.103.79"
-	all, err := db.GetAll(ip)
-	
-	if err != nil {
-		fmt.Print(err)
-		return
-	}
-	
-	fmt.Printf("ModuleVersion: %s\n", ip2proxy.ModuleVersion())
-	fmt.Printf("PackageVersion: %s\n", db.PackageVersion())
-	fmt.Printf("DatabaseVersion: %s\n", db.DatabaseVersion())
-	
-	fmt.Printf("IsProxy: %s\n", strconv.Itoa(int(all.IsProxy)));
-	fmt.Printf("ProxyType: %s\n", all.ProxyType);
-	fmt.Printf("CountryShort: %s\n", all.CountryShort);
-	fmt.Printf("CountryLong: %s\n", all.CountryLong);
-	fmt.Printf("Region: %s\n", all.Region);
-	fmt.Printf("City: %s\n", all.City);
-	fmt.Printf("Isp: %s\n", all.Isp);
-	fmt.Printf("Domain: %s\n", all.Domain);
-	fmt.Printf("UsageType: %s\n", all.UsageType);
-	fmt.Printf("Asn: %s\n", all.Asn);
-	fmt.Printf("As: %s\n", all.As);
-	fmt.Printf("LastSeen: %s\n", all.LastSeen);
-	fmt.Printf("Threat: %s\n", all.Threat);
-	
-	db.Close()
-}
-```
-
-## QUERY USING THE IP2PROXY PROXY DETECTION WEB SERVICE
-
-## Methods
-Below are the methods supported in this class.
-
-|Method Name|Description|
-|---|---|
-|OpenWS(apikey string, apipackage string, usessl bool)| Expects 3 input parameters:<ol><li>IP2Proxy API Key.</li><li>Package (PX1 - PX11)</li></li><li>Use HTTPS or HTTP</li></ol> |
-|LookUp(ipAddress string)|Query IP address. This method returns a struct containing the proxy info. <ul><li>CountryCode</li><li>CountryName</li><li>RegionName</li><li>CityName</li><li>ISP</li><li>Domain</li><li>UsageType</li><li>ASN</li><li>AS</li><li>LastSeen</li><li>Threat</li><li>ProxyType</li><li>IsProxy</li><li>Provider</li><ul>|
-|GetCredit()|This method returns the web service credit balance in a struct.|
-
-```go
-package main
-
-import (
-	"fmt"
-	"github.com/ip2location/ip2proxy-go/v3"
-)
-
-func main() {
-	apikey := "YOUR_API_KEY"
-	apipackage := "PX11"
-	usessl := true
-
-	ws, err := ip2proxy.OpenWS(apikey, apipackage, usessl)
-
-	if err != nil {
-		fmt.Print(err)
-		return
-	}
-	ip := "8.8.8.8"
-	res, err := ws.LookUp(ip)
-
-	if err != nil {
-		fmt.Print(err)
-		return
-	}
-
-	if res.Response != "OK" {
-		fmt.Printf("Error: %s\n", res.Response)
-	} else {
-		fmt.Printf("IsProxy: %s\n", res.IsProxy)
-		fmt.Printf("ProxyType: %s\n", res.ProxyType)
-		fmt.Printf("CountryCode: %s\n", res.CountryCode)
-		fmt.Printf("CountryName: %s\n", res.CountryName)
-		fmt.Printf("RegionName: %s\n", res.RegionName)
-		fmt.Printf("CityName: %s\n", res.CityName)
-		fmt.Printf("ISP: %s\n", res.ISP)
-		fmt.Printf("Domain: %s\n", res.Domain)
-		fmt.Printf("UsageType: %s\n", res.UsageType)
-		fmt.Printf("ASN: %s\n", res.ASN)
-		fmt.Printf("AS: %s\n", res.AS)
-		fmt.Printf("LastSeen: %s\n", res.LastSeen)
-		fmt.Printf("Threat: %s\n", res.Threat)
-		fmt.Printf("Provider: %s\n", res.Provider)
-	}
-
-	res2, err := ws.GetCredit()
-
-	if err != nil {
-		fmt.Print(err)
-		return
-	}
-	
-	fmt.Printf("Credit Balance: %s\n", res2.Response)
-}
-```
+## Developer Documentation
+To learn more about installation, usage, and code examples, please visit the developer documentation at [https://ip2proxy-go.readthedocs.io/en/latest/index.html.](https://ip2proxy-go.readthedocs.io/en/latest/index.html)