diff --git a/README.md b/README.md index cfb55a7..ca243a8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,41 @@ +
+ +SatsPrice Logo + # SatsPrice -This app fetches the price of Bitcoin relative to common ISO currencies from multiple sources, and converts inputted amounts between Sats, BTC, and the selected ISO currency. +This app fetches the price of Bitcoin relative to common fiat currencies from multiple sources, and converts inputted amounts between Sats, BTC, and the selected fiat currency. + +[![GitHub downloads](https://img.shields.io/github/downloads/tyiu/sats-price/total?label=Downloads&labelColor=27303D&color=0D1117&logo=github&logoColor=FFFFFF&style=flat)](https://github.com/tyiu/sats-price/releases) + +[![Last Version](https://img.shields.io/github/release/tyiu/sats-price?maxAge=3600&label=Stable&labelColor=06599d&color=043b69)](https://github.com/tyiu/sats-price) +[![License: GPL-3.0](https://img.shields.io/github/license/tyiu/sats-price?labelColor=27303D&color=0877d2)](/LICENSE) + +## Download and Install + +[](https://apps.apple.com/app/satsprice/id6478230475) +[](https://github.com/zapstore/zapstore/releases) +[](https://github.com/ImranR98/Obtainium) +[Get it on GitHub](https://github.com/tyiu/sats-price/releases) + +## Supported Platforms + +iOS 16.0+ • macOS 13.0+ • Android 10.0+ + +
+ +## Building This is a free [Skip](https://skip.tools) dual-platform app project. It builds a native app for both iOS and Android. -## Building - This project is both a stand-alone Swift Package Manager module, as well as an Xcode project that builds and transpiles the project into a Kotlin Gradle project for Android using the Skip plugin. @@ -48,3 +77,10 @@ Android Studio's logcat tab for the transpiled Kotlin app. This project depends on [Skip](https://skip.tools) to build as a multi-platform app. The [Bitcoin Calculator](https://www.flaticon.com/free-icons/bitcoin-calculator) icon was created by Icon home and licensed as free for personal and commercial use with attribution. + +The following free APIs are used: +- Coinbase + - [Get Exchange Rates](https://docs.cdp.coinbase.com/coinbase-app/docs/api-exchange-rates#get-exchange-rates) + - [Get Spot Price](https://docs.cdp.coinbase.com/coinbase-app/docs/api-prices#get-spot-price) +- CoinGecko + - [Coin Price by IDs](https://docs.coingecko.com/reference/simple-price) \ No newline at end of file diff --git a/docs/assets/download_on_apple.svg b/docs/assets/download_on_apple.svg new file mode 100755 index 0000000..072b425 --- /dev/null +++ b/docs/assets/download_on_apple.svg @@ -0,0 +1,46 @@ + + Download_on_the_App_Store_Badge_US-UK_RGB_blk_4SVG_092917 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/download_on_github.svg b/docs/assets/download_on_github.svg new file mode 100644 index 0000000..37fa923 --- /dev/null +++ b/docs/assets/download_on_github.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/download_on_obtainium.png b/docs/assets/download_on_obtainium.png new file mode 100644 index 0000000..4f36053 Binary files /dev/null and b/docs/assets/download_on_obtainium.png differ diff --git a/docs/assets/download_on_zapstore.svg b/docs/assets/download_on_zapstore.svg new file mode 100644 index 0000000..0afee4a --- /dev/null +++ b/docs/assets/download_on_zapstore.svg @@ -0,0 +1,237 @@ + + + + diff --git a/docs/assets/satsprice-logo.png b/docs/assets/satsprice-logo.png new file mode 100644 index 0000000..91829db Binary files /dev/null and b/docs/assets/satsprice-logo.png differ