Skip to content

Add sections in the README file about how to use GeoAPI #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pomadchin merged 1 commit into from
May 6, 2025
+34 −2
Merged

Add sections in the README file about how to use GeoAPI #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ It is designed to be compatible with `proj.4` parameters and derives some of its

Proj4J is a project in the [LocationTech](http://www.locationtech.org) working group of the Eclipse Foundation.

![LocationTech](locationtech_mark.png)
![LocationTech](locationtech_mark.png)

## User Guide

Proj4J artifacts are available on maven central.

**!Important!** As of `1.2.2` version, `proj4-core` contains no EPSG Licensed files.
**!Important!** As of `1.2.2` version, `proj4-core` contains no EPSG Licensed files.
In order to make proj4j properly operate, it makes sense to consider `proj4-epsg` dependency usage.

### Using Proj4J with Maven
Expand Down Expand Up @@ -46,6 +46,25 @@ To include `Proj4J-EPSG` in a Maven project, add a dependency block like the fol
```
where `{latest version}` refers to the version indicated by the badge above.

#### Using Proj4j with GeoAPI

`Proj4j-GeoAPI` module provides wrappers for using Proj4J behind [GeoAPI](https://www.geoapi.org/) interfaces.
GeoAPI is a set of Java interfaces derived from OGC/ISO standards
for using different implementations of metadata and referencing services through a standard API.
To include the module in a Maven project, add a dependency block like the following:
```xml
<properties>
<proj4j.version>{latest version}</proj4j.version>
</properties>
<dependency>
<groupId>org.locationtech.proj4j</groupId>
<artifactId>proj4j-geoapi</artifactId>
<version>${proj4j.version}</version>
</dependency>
```
where `{latest version}` refers to the version indicated by the badge above.
Usage examples are available on the [GeoAPI site](https://www.geoapi.org/java/examples/usage.html).

### Using Proj4J with Gradle

To include Proj4J in a Gradle project, add a dependency block like the following:
Expand All @@ -68,6 +87,19 @@ To include `Proj4J-EPSG` in a Gradle project, add the following line to the depe
```
where `{latest version}` refers to the version indicated by the badge above.

#### Using Proj4j with GeoAPI

`Proj4j-GeoAPI` module provides wrappers for using Proj4J behind [GeoAPI](https://www.geoapi.org/) interfaces.
GeoAPI is a set of Java interfaces derived from OGC/ISO standards
for using different implementations of metadata and referencing services through a standard API.
To include the module in a Gradle project, add the following line to the dependency block:

```
implementation 'org.locationtech.proj4j:proj4j-geoapi:{latest version}'
```
where `{latest version}` refers to the version indicated by the badge above.
Usage examples are available on the [GeoAPI site](https://www.geoapi.org/java/examples/usage.html).

### Basic Usage

The following examples give a quick intro on how to use Proj4J in common
Expand Down