Skip to content

Commit

Permalink
Readme added
Browse files Browse the repository at this point in the history
  • Loading branch information
bartalos86 committed Jun 1, 2021
1 parent d35f305 commit ab61a83
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Cryptocoins Widget for Rainmeter

This is a fork of [pbojan's](https://github.com/pbojan/cryptocoins-desklet-windows) rainmeter widget ported to use the free Nomics Crypto price API.

## Modifications

- Rewritten data parsing to work with the Nomics API.
- Rewritten dynamic icon fetching for the compact widgets.
- Added compact variations for the widgets.
- Separated API.ini from the GUI's
- Removed update functionality

## Compact Widgets

![Compact widget screenshot](https://i.ibb.co/1MKG0Jx/compact-screenshot.png)

# Installation

- Option 1:
Download the repository and place it in the Rainmeter's Skins folder (usually `Documents\Rainmeter\Skins`) and restart Rainmeter
- Option 2:
Download the `.rmskin` and and with a double-click install it.

After the widget is installed you need to add a file called ApiKey.ini to the skin's @Resources folder.
**`ApiKey.ini`**
`[Variables]
APIKey=YourAPIKey
`
The `.rmkskin` version might come with the file, in that case you have to just modify it.


0 comments on commit ab61a83

Please sign in to comment.