CHANGELOG.md rotation, README.md update

locationtech · Dec 13, 2022 · 10e3297 · 10e3297
1 parent e8eae2c
commit 10e3297
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -35,3 +35,4 @@ _SUCCESS
 .ensime*
 tags
 .vscode
+.metals
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+- Move all core resources to epsg submodule [#95](https://github.com/locationtech/proj4j/pull/95)
+
 ## [1.2.1] - 2022-12-12
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -13,45 +13,49 @@ Proj4J artifacts are available on maven central.
 
 ### Using Proj4J with Maven
 
-To include Proj4J in a Maven project, add a dependency block like the following:
+**!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.
 
+To include Proj4J in a Maven project, add a dependency block like the following:
 ```xml
 <properties>
-    <proj4j.version><latest version></proj4j.version>
+    <proj4j.version>{latest version}</proj4j.version>
 </properties>
 <dependency>
     <groupId>org.locationtech.proj4j</groupId>
     <artifactId>proj4j</artifactId>
     <version>${proj4j.version}</version>
 </dependency>
 ```
-where `<latest version>` refers to the version indicated by the badge above.
-
-### Using Proj4J with Gradle
-
-To include Proj4J in a Gradle project, add a dependency block like the following:
+where `{latest version}` refers to the version indicated by the badge above.
 
-```
-dependencies {
-    implementation 'org.locationtech.proj4j:proj4j:<latest version>'
-}
-```
-where `<latest version>` refers to the version indicated by the badge above.
+#### Proj4j EPSG
 
-### Proj4j EPSG
+`Proj4J-EPSG` module distributes a portion of the EPSG dataset. This artifact is released the [EPSG database distribution license](https://raw.githubusercontent.com/locationtech/proj4j/master/LICENSE.EPSG).
 
-Proj4J-EPSG module distributes a portion of the EPSG dataset. This artifact is released the [EPSG database distribution license](https://raw.githubusercontent.com/locationtech/proj4j/master/LICENSE.EPSG).
+To include `Proj4J-EPSG` in a Maven project, add a dependency block like the following:
 ```xml
 <properties>
-    <proj4j.version><latest version></proj4j.version>
+    <proj4j.version>{latest version}</proj4j.version>
 </properties>
 <dependency>
     <groupId>org.locationtech.proj4j</groupId>
     <artifactId>proj4j-epsg</artifactId>
     <version>${proj4j.version}</version>
 </dependency>
 ```
-where `<latest version>` refers to the version indicated by the badge above.
+where `{latest version}` refers to the version indicated by the badge above.
+
+### Using Proj4J with Gradle
+
+To include Proj4J in a Gradle project, add a dependency block like the following:
+
+```
+dependencies {
+    implementation 'org.locationtech.proj4j:proj4j:{latest version}'
+}
+```
+where `{latest version}` refers to the version indicated by the badge above.
 
 ### Basic Usage
-Original file line number
+Diff line change
@@ Expand Up / @@ -35,3 +35,4 @@ _SUCCESS @@
     .ensime*
     tags
     .vscode
+    .metals