Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fedecalendino committed Feb 7, 2023
1 parent afce303 commit e636ec9
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 16 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,23 @@

##### Favorite cryptocurrencies

You can find the identifiers at the end of any coingecko url: https://www.coingecko.com/en/coins/{id}
This is a list of `api` ids provided by coingecko, to find yours follow these simple steps:

For example:
1. go to the page of any cryptocurrency in coingecko.
2. find the **info** section.
3. copy the value under the `API id` field.
4. paste the id into the alfred setting in a new line.

* ADA: https://www.coingecko.com/en/coins/cardano
* ATOM: https://www.coingecko.com/en/coins/cosmos
* BTC: https://www.coingecko.com/en/coins/bitcoin
* ETH: https://www.coingecko.com/en/coins/ethereum
###### example:

* **name**: BNB
* **url**: https://www.coingecko.com/en/coins/bnb
* **api id**: binancecoin

![api id example](screenshots/api-id.png)

#### Usage:

#### Usage:

##### • favorites (from configuration)

Expand Down
22 changes: 14 additions & 8 deletions info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -248,16 +248,22 @@
---
FAVORITES
### Favorite Cryptocurrencies
You can find the identifiers at the end of any coingecko url: https://www.coingecko.com/en/coins/{id}
This is a list of `api` ids provided by coingecko, to find yours follow these simple steps:
For example:
1. go to the page of any cryptocurrency in coingecko.
2. find the **info** section.
3. copy the value under the `API id` field.
4. paste the id into the alfred setting in a new line.
* ADA: https://www.coingecko.com/en/coins/cardano
* ATOM: https://www.coingecko.com/en/coins/cosmos
* BTC: https://www.coingecko.com/en/coins/bitcoin
* ETH: https://www.coingecko.com/en/coins/ethereum</string>
#### example:
* **name**: BNB
* **url**: https://www.coingecko.com/en/coins/bnb
* **api id**: binancecoin
* **screenshot**: [github.com](https://github.com/fedecalendino/alfred-crypto-prices/blob/main/screenshots/api-id.png)</string>
<key>uidata</key>
<dict>
<key>22BF0D5B-26C6-4E46-B6A7-1774D82A4DB3</key>
Expand Down Expand Up @@ -533,7 +539,7 @@ For example:
</dict>
</array>
<key>version</key>
<string>1.9.0</string>
<string>1.9.1</string>
<key>webaddress</key>
<string>https://github.com/fedecalendino/alfred-crypto-prices</string>
</dict>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "Crypto Prices"
version = "1.9.0"
version = "1.9.1"
description = "Get current prices for cryptocurrencies"
documentation = "https://github.com/fedecalendino/alfred-crypto-prices/blob/main/README.md"
homepage = "https://github.com/fedecalendino/alfred-crypto-prices"
Expand Down
Binary file added screenshots/api-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e636ec9

Please sign in to comment.