Update README
This commit is contained in:
42
README.md
42
README.md
@@ -1,12 +1,41 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="./docs/assets/satsprice-logo.png" alt="SatsPrice Logo" title="SatsPrice logo" width="256"/>
|
||||
|
||||
# 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.
|
||||
|
||||
[](https://github.com/tyiu/sats-price/releases)
|
||||
|
||||
[](https://github.com/tyiu/sats-price)
|
||||
[](/LICENSE)
|
||||
|
||||
## Download and Install
|
||||
|
||||
[<img src="./docs/assets/download_on_apple.svg"
|
||||
alt="Download on the Apple App Store"
|
||||
height="70">](https://apps.apple.com/app/satsprice/id6478230475)
|
||||
[<img src="./docs/assets/download_on_zapstore.svg"
|
||||
alt="Get it on Zap Store"
|
||||
height="70">](https://github.com/zapstore/zapstore/releases)
|
||||
[<img src="./docs/assets/download_on_obtainium.png"
|
||||
alt="Get it on Obtaininum"
|
||||
height="70">](https://github.com/ImranR98/Obtainium)
|
||||
[<img src="./docs/assets/download_on_github.svg" alt="Get it on GitHub"
|
||||
height="70">](https://github.com/tyiu/sats-price/releases)
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
iOS 16.0+ • macOS 13.0+ • Android 10.0+
|
||||
|
||||
</div>
|
||||
|
||||
## 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)
|
||||
Reference in New Issue
Block a user