some readme cleanup

osslabz · Nov 9, 2023 · bd28716 · bd28716
1 parent d385f81
commit bd28716
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,43 @@
-CoinGecko Client (Java)
-=======================
-![GitHub](https://img.shields.io/github/license/osslabz/coingecko-client)
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/osslabz/coingecko-client/maven.yml?branch=master)
-[![Maven Central](https://img.shields.io/maven-central/v/net.osslabz/coingecko-client?label=Maven%20Central)](https://search.maven.org/artifact/net.osslabz/coingecko-client)
+![GitHub](https://img.shields.io/github/license/osslabz/coingecko-java)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/osslabz/coingecko-java/maven.yml?branch=master)
+[![Maven Central](https://img.shields.io/maven-central/v/net.osslabz/coingecko-java?label=Maven%20Central)](https://search.maven.org/artifact/net.osslabz/coingecko-client)
 
-This is a (synced) fork of [Philipinho/CoinGecko-Java](https://github.com/Philipinho/CoinGecko-Java) that is properly releases on [Maven Central](https://search.maven.org/artifact/net.osslabz/coingecko-client).
+This is a (synced) fork of [Philipinho/CoinGecko-Java](https://github.com/Philipinho/CoinGecko-Java) that is properly releases on [Maven Central](https://search.maven.org/artifact/net.osslabz/coingecko-java).
 
 Once [Enable CI and Automated Release Management #41](https://github.com/Philipinho/CoinGecko-Java/pull/41) is merged and the original project is published this fork will be discontinued.
 
+Usage
+---------
+
+### Maven
+
+```xml
+<dependency>
+    <groupId>net.osslabz</groupId>
+    <artifactId>coingecko-java</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+### Gradle (Groovy)
+
+```groovy
+dependencies {
+    implementation 'net.osslabz:coingecko-java:1.0.0'
+}
+```
+
+### Gradle (Kotlin)
+
+```kotlin
+dependencies {
+    implementation ("net.osslabz:coingecko-java:1.0.0")
+}
+```
+
+
+**For further info see below the original README.**
+
 ---
 
 # CoinGecko-Java

diff --git a/pom.xml b/pom.xml
@@ -5,12 +5,12 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>net.osslabz</groupId>
-    <artifactId>coingecko-client</artifactId>
-    <version>1.0.1</version>
+    <artifactId>coingecko-java</artifactId>
+    <version>1.0.1-SNAPSHOT</version>
 
     <name>${project.groupId}:${project.artifactId}</name>
     <description>Java wrapper for the CoinGecko API</description>
-    <url>https://github.com/osslabz/coingecko-client</url>
+    <url>https://github.com/osslabz/coingecko-java</url>
 
     <properties>
         <maven.compiler.release>8</maven.compiler.release>
@@ -36,9 +36,9 @@
     </developers>
 
     <scm>
-        <connection>scm:git:ssh://git@github.com/osslabz/coingecko-client.git</connection>
-        <developerConnection>scm:git:ssh://git@github.com/osslabz/coingecko-client.git</developerConnection>
-        <url>https://github.com/osslabz/coingecko-client</url>
+        <connection>scm:git:ssh://git@github.com/osslabz/coingecko-java.git</connection>
+        <developerConnection>scm:git:ssh://git@github.com/osslabz/coingecko-java.git</developerConnection>
+        <url>https://github.com/osslabz/coingecko-java</url>
         <tag>HEAD</tag>
     </scm>