Skip to content

Commit 575efd2

Browse files
committed
#192: Update README.
Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>
1 parent 5c86a55 commit 575efd2

File tree

1 file changed

+6
-48
lines changed

1 file changed

+6
-48
lines changed

README.md

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# JPX
22

33
![Build Status](https://github.com/jenetics/jpx/actions/workflows/gradle.yml/badge.svg)
4-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.jenetics/jpx/badge.svg)](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22jpx%22)
4+
[![Maven Central Version](https://img.shields.io/maven-central/v/io.jenetics/jpx?color=green)](https://central.sonatype.com/artifact/io.jenetics/jpx)
55
[![Javadoc](https://www.javadoc.io/badge/io.jenetics/jpx.svg)](http://www.javadoc.io/doc/io.jenetics/jpx)
66

7-
**JPX** is a Java library for creating, reading and writing [GPS](https://en.wikipedia.org/wiki/Global_Positioning_System) data in [GPX](https://en.wikipedia.org/wiki/GPS_Exchange_Format) format. It is a *full* implementation of version [1.1](http://www.topografix.com/GPX/1/1/) and version [1.0](http://www.topografix.com/gpx_manual.asp) of the GPX format. The data classes are completely immutable and allows a functional programming style. They are working also nicely with the Java [Stream](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Stream.html) API. It is also possible to convert the location information into strings which are compatible to the [ISO 6709](http://en.wikipedia.org/wiki/ISO_6709) standard.
7+
8+
**JPX** is a Java library for creating, reading and writing [GPS](https://en.wikipedia.org/wiki/Global_Positioning_System) data in [GPX](https://en.wikipedia.org/wiki/GPS_Exchange_Format) format. It is a *full* implementation of version [1.1](http://www.topografix.com/GPX/1/1/) and version [1.0](http://www.topografix.com/gpx_manual.asp) of the GPX format. The data classes are completely immutable and allows a functional programming style. They are working also nicely with the Java [Stream](https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/stream/Stream.html) API. It is also possible to convert the location information into strings which are compatible to the [ISO 6709](http://en.wikipedia.org/wiki/ISO_6709) standard.
89

910
Besides the basic functionality of reading and writing GPX files, the library also allows manipulating the read GPX object in a functional way.
1011

1112

1213
## Dependencies
1314

14-
The _JPX_ library needs no external dependencies. It only needs **Java 17** to compile and run. It also runs and compiles with **Java 21** and **Java 23**.
15+
The _JPX_ library needs no external dependencies. It needs **Java 25** to compile and run.
1516

1617

1718
## Building JPX
@@ -314,7 +315,7 @@ org.acme.NonValidatingDocumentBuilder
314315

315316
The library is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
316317

317-
Copyright 2016-2025 Franz Wilhelmstötter
318+
Copyright 2016-2026 Franz Wilhelmstötter
318319

319320
Licensed under the Apache License, Version 2.0 (the "License");
320321
you may not use this file except in compliance with the License.
@@ -330,7 +331,7 @@ The library is licensed under the [Apache License, Version 2.0](http://www.apach
330331

331332
## Release notes
332333

333-
### [3.2.1](https://github.com/jenetics/jpx/releases/tag/v3.2.1)
334+
### [4.0.0](https://github.com/jenetics/jpx/releases/tag/v4.0.0)
334335

335336
#### Improvements
336337

@@ -345,47 +346,4 @@ The library is licensed under the [Apache License, Version 2.0](http://www.apach
345346

346347
### [3.1.0](https://github.com/jenetics/jpx/releases/tag/v3.1.0)
347348

348-
#### Improvements
349-
350-
* [#170](https://github.com/jenetics/jpx/issues/170): GPX files with invalid version number are now readable in _LENIENT_ mode.
351-
```java
352-
final GPX gpx;
353-
try (InputStream in = new FileInputStream(resource)) {
354-
gpx = GPX.Reader.of(Mode.LENIENT).read(in);
355-
}
356-
```
357-
358-
#### Bugs
359-
360-
* [#167](https://github.com/jenetics/jpx/issues/167): Fixing a test case for Windows.
361-
362-
### [3.0.1](https://github.com/jenetics/jpx/releases/tag/v3.0.1)
363-
364-
#### Bugs
365-
366-
* [#162](https://github.com/jenetics/jpx/issues/162): Elevation serialization for values > 1000m is incompatible with deserialization.
367-
368-
### [3.0.0](https://github.com/jenetics/jpx/releases/tag/v3.0.0)
369-
370-
#### Improvements
371-
372-
* [#125](https://github.com/jenetics/jpx/issues/125): **Breaking change** - Use `Instant` instead of `ZonedDateTime` for `Point.time` property.
373-
* [#148](https://github.com/jenetics/jpx/issues/148): **Breaking change** - Update to Java17.
374-
* [#155](https://github.com/jenetics/jpx/issues/155): Improved `GPX.Reader` and `GPX.Writer` classes.
375-
* [#158](https://github.com/jenetics/jpx/issues/158): Add XML `Document` reader/writer methods.
376-
```java
377-
final GPX gpx = ...;
378-
379-
final Document doc = XMLProvider.provider()
380-
.documentBuilderFactory()
381-
.newDocumentBuilder()
382-
.newDocument();
383-
384-
// The GPX data are written to the empty `doc` object.
385-
GPX.Writer.DEFAULT.write(gpx, new DOMResult(doc));
386-
```
387-
388-
#### Bugs
389349

390-
* [#151](https://github.com/jenetics/jpx/issues/151): `Double`'s being written as exponents in GPX file.
391-
* [#152](https://github.com/jenetics/jpx/issues/152): `LocationFormatter::parse` method is not thread-safe.

0 commit comments

Comments
 (0)