From 8fc2a01d5b9a781c6289a88ce982ef7be094bc43 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Fri, 9 Sep 2022 11:54:20 -0700 Subject: [PATCH] Preping for 1.0.0 release --- README.md | 12 ++++++------ build.gradle.kts | 2 +- examples/build.gradle.kts | 2 +- pom.xml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c006e9f..98f1527 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause) [![Release](https://img.shields.io/github/release/ethauvin/cryptoprice.svg)](https://github.com/ethauvin/cryptoprice/releases/latest) [![Nexus Snapshot](https://img.shields.io/nexus/s/net.thauvin.erik/cryptoprice?server=https%3A%2F%2Foss.sonatype.org%2F)](https://oss.sonatype.org/content/repositories/snapshots/net/thauvin/erik/cryptoprice/) +[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause) [![Release](https://img.shields.io/github/release/ethauvin/cryptoprice.svg)](https://github.com/ethauvin/cryptoprice/releases/latest) [![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/cryptoprice.svg?label=maven%20central&color=blue)](https://search.maven.org/search?q=g:%22net.thauvin.erik%22%20AND%20a:%22cryptoprice%22) [![Known Vulnerabilities](https://snyk.io/test/github/ethauvin/cryptoprice/badge.svg?targetFile=pom.xml)](https://snyk.io/test/github/ethauvin/cryptoprice?targetFile=pom.xml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_cryptoprice&metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_cryptoprice) [![GitHub CI](https://github.com/ethauvin/cryptoprice/actions/workflows/gradle.yml/badge.svg)](https://github.com/ethauvin/cryptoprice/actions/workflows/gradle.yml) [![CircleCI](https://circleci.com/gh/ethauvin/cryptoprice/tree/master.svg?style=shield)](https://circleci.com/gh/ethauvin/cryptoprice/tree/master) @@ -9,10 +9,10 @@ A simple Kotlin/Java/Android implementation of the prices [Coinbase Public API]( ## Examples (TL;DR) ```kotlin +import net.thauvin.erik.crypto.CryptoPrice.Companion.buyPrice +import net.thauvin.erik.crypto.CryptoPrice.Companion.sellPrice import net.thauvin.erik.crypto.CryptoPrice.Companion.spotPrice -// ... - val btc = spotPrice("BTC") // Bitcoin println(btc.amount) @@ -31,7 +31,7 @@ To use with [Gradle](https://gradle.org/), include the following dependency in y ```gradle dependencies { - implementation("net.thauvin.erik:cryptoprice:1.0.0-SNAPSHOT") + implementation("net.thauvin.erik:cryptoprice:1.0.0") } ``` @@ -99,7 +99,7 @@ println(price.toJson()) {"data":{"base":"BTC","currency":"USD","amount":"34567.89"}} ``` -The `data` object matches the [Coinbase API](https://docs.cloud.coinbase.com/sign-in-with-coinbase/docs/api-prices#get-spot-price). To specify a different (or no) key, use: +The `data` object matches the [Coinbase API](https://docs.cloud.coinbase.com/sign-in-with-coinbase/docs/api-prices). To specify a different (or no) key, use: ```kotlin println(price.toJson("bitcoin")) @@ -130,7 +130,7 @@ apiCall(listOf("exchange-rates"), mapOf("currency" to "usd")) will return something like: ```json -{"data":{"currency":"BTC","rates":{"AED":"36.73","AFN":"589.50",...}}} +{"data":{"currency":"BTC","rates":{"AED":"36.73","AFN":"589.50",…}}} ``` See the [examples](https://github.com/ethauvin/cryptoprice/blob/master/examples/) for more details. diff --git a/build.gradle.kts b/build.gradle.kts index 89c96de..73d2675 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -22,7 +22,7 @@ defaultTasks(ApplicationPlugin.TASK_RUN_NAME) description = "Retrieve cryptocurrencies prices." group = "net.thauvin.erik" -version = "1.0.0-SNAPSHOT" +version = "1.0.0" val deployDir = "deploy" val gitHub = "ethauvin/$name" diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts index bb8adad..3aa5bef 100644 --- a/examples/build.gradle.kts +++ b/examples/build.gradle.kts @@ -20,7 +20,7 @@ repositories { } dependencies { - implementation("net.thauvin.erik:cryptoprice:1.0.0-SNAPSHOT") + implementation("net.thauvin.erik:cryptoprice:1.0.0") implementation("org.json:json:20220320") } diff --git a/pom.xml b/pom.xml index 0fb30a7..e92e855 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ 4.0.0 net.thauvin.erik cryptoprice - 1.0.0-SNAPSHOT + 1.0.0 cryptoprice Retrieve cryptocurrencies prices. https://github.com/ethauvin/cryptoprice