Skip to content

Commit 59e0977

Browse files
committed
Fixed some typos
1 parent de09d5b commit 59e0977

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ To do this, add the dependency to your pom.xml:
2525

2626
## Usage ##
2727

28-
*Note:* For accessing MaxMind GeoIP2 databases, we generally recommend
29-
using the GeoIP2 Java API rather than using this package directly.
28+
*Note:* For accessing MaxMind GeoIP2 databases, we generally recommend using
29+
the GeoIP2 Java API rather than using this package directly.
3030

31-
To use the API, you must first create a `Reader` object. The constructor
32-
for the reader object takes a `File` representing your MaxMind DB. Optionally
33-
you may pass a second parameter with a `FileMode` of `MEMORY_MAP` or
34-
`IN_MEMORY`. The default mode is `MEMORY_MAP`, which maps the file to virtual
31+
To use the API, you must first create a `Reader` object. The constructor for
32+
the reader object takes a `File` representing your MaxMind DB. Optionally you
33+
may pass a second parameter with a `FileMode` with a valueof `MEMORY_MAP` or
34+
`MEMORY`. The default mode is `MEMORY_MAP`, which maps the file to virtual
3535
memory. This often provides performance comparable to loading the file into
36-
real memory with `IN_MEMORY` while using significantly less memory.
36+
real memory with `MEMORY`.
3737

3838
To look up an IP address, pass the address as an `InetAddress` to the `get`
3939
method on `Reader`. This method will return the result as a
40-
`com.fasterxml.jackson.databind.JsonNode` object. `JsonNode` objects are
41-
used as they provide a convenient representation of multi-type data
42-
structures and the databind package of Jackson 2 supplies many tools for
43-
interacting with the data in this format.
40+
`com.fasterxml.jackson.databind.JsonNode` object. `JsonNode` objects are used
41+
as they provide a convenient representation of multi-type data structures and
42+
the databind package of Jackson 2 supplies many tools for interacting with the
43+
data in this format.
4444

4545
## Example ##
4646

@@ -51,11 +51,11 @@ Reader reader = new Reader(database);
5151

5252
InetAddress address = InetAddress.getByName("24.24.24.24");
5353

54-
JsonNode result = reader.get(address);
54+
JsonNode response = reader.get(address);
5555

56-
System.out.println(result);
56+
System.out.println(response);
5757

58-
result.close();
58+
reader.close();
5959

6060
```
6161

@@ -69,7 +69,7 @@ DB-perl) for the format.
6969
## Bug Tracker ##
7070

7171
Please report all issues with this code using the [GitHub issue tracker]
72-
(https://github.com/maxmind/MaxMind-DB-java/issues).
72+
(https://github.com/maxmind/MaxMind-DB-Reader-java/issues).
7373

7474
If you are having an issue with a MaxMind database or service that is not
7575
specific to this reader, please [contact MaxMind support]

0 commit comments

Comments
 (0)