Skip to content

Commit 92dcf68

Browse files
committed
Updated docs in preparation for a release
1 parent 0908530 commit 92dcf68

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
CHANGELOG
22
=========
33

4-
0.3.0 (2013-10-XX)
4+
0.3.0 (2013-10-17)
55
------------------
66

77
* IMPORTANT: The package name was changed to `com.maxmind.db`. The
88
`MaxMindDbReader` class was renamed to `Reader`.
99
* Improved error handling and test coverage.
1010
* Performance improvements.
1111

12-
1312
0.2.0 (2013-07-08)
1413
------------------
1514

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# MaxMind DB Reader #
22

3-
**NOTE**: This is an alpha release, and the API may change before the final
3+
**NOTE**: This is a beta release, and the API may change before the final
44
production release.
55

66
## Description ##
77

8-
This is the Java API for reading MaxMind DB files. MaxMind DB is a binary
9-
file format that stores data indexed by IP address subnets (IPv4 or IPv6).
8+
This is the Java API for reading MaxMind DB files. MaxMind DB is a binary file
9+
format that stores data indexed by IP address subnets (IPv4 or IPv6).
1010

1111
## Installation ##
1212

@@ -19,7 +19,7 @@ To do this, add the dependency to your pom.xml:
1919
<dependency>
2020
<groupId>com.maxmind.db</groupId>
2121
<artifactId>maxminddb</artifactId>
22-
<version>0.2.0</version>
22+
<version>0.3.0</version>
2323
</dependency>
2424
```
2525

@@ -58,11 +58,13 @@ System.out.println(result);
5858
result.close();
5959

6060
```
61+
6162
## Format ##
6263

63-
The MaxMind DB format is an open format for quickly mapping IP addresses
64-
to records. The [specification](https://github.com/maxmind/MaxMind-DB-perl/blob/master/docs/MaxMind-IPDB-spec.md) is available as part of our
65-
[Perl writer](https://github.com/maxmind/MaxMind-DB-perl) for the format.
64+
The MaxMind DB format is an open format for quickly mapping IP addresses to
65+
records. The [specification](https://github.com/maxmind/MaxMind-DB-perl/blob/master/docs/MaxMind-IPDB-spec.md)
66+
is available as part of our [Perl writer](https://github.com/maxmind/MaxMind-
67+
DB-perl) for the format.
6668

6769
## Bug Tracker ##
6870

@@ -75,9 +77,8 @@ specific to this reader, please [contact MaxMind support]
7577

7678
## Requirements ##
7779

78-
MaxMind has tested this API with Java 6 and above. Reasonable patches
79-
for Java 5 will be accepted. Patches for 1.4 or earlier will not be
80-
accepted.
80+
MaxMind has tested this API with Java 6 and above. Reasonable patches for Java
81+
5 will be accepted. Patches for 1.4 or earlier will not be accepted.
8182

8283
## Contributing ##
8384

0 commit comments

Comments
 (0)