Skip to content

Commit 2fbc936

Browse files
committed
Documentation update
1 parent d38f140 commit 2fbc936

File tree

1 file changed

+36
-15
lines changed

1 file changed

+36
-15
lines changed

README.md

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
1-
# Java-IPinfo: A java wrapper for the [IPinfo](https://ipinfo.io/) API.
1+
# [<img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/>](https://ipinfo.io/) IPinfo Java Client Library
22

33
[![License](http://img.shields.io/:license-apache-blue.svg)](LICENSE)
44
[![Travis](https://travis-ci.com/ipinfo/java.svg?branch=master&style=flat-square)](https://travis-ci.com/ipinfo/java)
55

6-
Java-IPinfo is a lightweight wrapper for the IPinfo API, which provides up-to-date IP address data.
6+
This is the officialJava client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
7+
- IP geolocation (city, region, country, postal code, latitude and longitude)
8+
- ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
9+
- Company details (the name and domain of the business that uses the IP address)
10+
- Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
711

8-
## Features:
912

10-
- IP Lookup
11-
- ASN Lookup
1213

13-
## Usage
14+
### Getting Started
15+
16+
You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup?ref=lib-$LANGUAGE).
17+
18+
The free plan is limited to 1,000 requests a day, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing?ref=lib-$LANGUAGE)
19+
20+
#### Installation
21+
22+
##### Maven
23+
Add these values to your pom.xml file:
1424

15-
### Maven
1625
Repository:
1726

1827
```xml
@@ -37,9 +46,9 @@ Dependency:
3746
</dependencies>
3847
```
3948

40-
### Examples
49+
#### Quick Start
4150

42-
#### IP Information
51+
##### IP Information
4352

4453

4554
````java
@@ -65,7 +74,7 @@ public class Main {
6574
````
6675

6776

68-
#### ASN Information
77+
##### ASN Information
6978

7079
````java
7180
import io.ipinfo.api.IPInfo;
@@ -89,13 +98,13 @@ public class Main {
8998
}
9099
````
91100

92-
### Errors
101+
#### Errors
93102

94103
- ErrorResponseException: A runtime exception accessible through the ExecutionException of a future. This exception signals that something went wrong when mapping the API response to the wrapper. You probably can't recover from this exception.
95104

96105
- RateLimitedException An exception signalling that you've been rate limited.
97106

98-
### Caching
107+
#### Caching
99108

100109
This library provides a very simple caching system accessible in `SimpleCache`. Simple cache is an in memory caching system that resets every time you restart your code.
101110

@@ -127,7 +136,7 @@ public class Main {
127136
}
128137
```
129138

130-
### Country Name Lookup
139+
#### Country Name Lookup
131140

132141
This library provides a system to lookup country names through ISO2 country codes.
133142

@@ -162,7 +171,7 @@ This file must follow the same layout as seen [here](https://github.com/ipinfo/j
162171

163172
More language files can be found [here](https://country.io/data)
164173

165-
### Location Information
174+
#### Location Information
166175

167176
This library provides an easy way to get the latitude and longitude of an IP Address:
168177

@@ -190,8 +199,20 @@ public class Main {
190199
}
191200
```
192201

193-
## Extra Information
202+
#### Extra Information
194203

195204
- This library is thread safe. Feel free to call the different endpoints from different threads.
196205
- This library uses square's http client. Please refer to their documentation to get information on more functionality you can use.
197206

207+
208+
### Other Libraries
209+
210+
There are official IPinfo client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.
211+
212+
https://ipinfo.io/developers/libraries
213+
214+
### About IPinfo
215+
216+
Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier and IP type data sets. Our API handles over 12 billion requests a month for 100,000 businesses and developers.
217+
218+
[![image](https://avatars3.githubusercontent.com/u/15721521?s=128&u=7bb7dde5c4991335fb234e68a30971944abc6bf3&v=4)](https://ipinfo.io/)

0 commit comments

Comments
 (0)