Merge pull request #55 from deefrawley/currency_converter_detail

Currency Converter and General Converter plugin details update

Author: Yusyuriv

src/assets/styles/reset.css

@@ -21,7 +21,6 @@ time, mark, audio, video {
     border: 0;
     font-size: 100%;
     font: inherit;
-    vertical-align: baseline;
 }
 /* HTML5 display-role reset for older browsers */
 article, aside, details, figcaption, figure,

src/assets/styles/variables.css

@@ -56,6 +56,9 @@
     --plugin-official-text: #594504;
     --font-family: "Noto Sans", "Segoe UI", "Inter", sans-serif;
     --font-family-mono: "Source Code Pro", "JetBrains Mono", "Fira Code", "Roboto Mono", monospace;
+    --table-row-bg: #fff;
+    --table-row-bg-alternate: #f7fbff;
+    --table-cell-sep: #e0e8f0;
 }
 
 :root[data-theme="dark"] {
@@ -107,4 +110,7 @@
     --theme-toggle-button-icon: #d8d8d8;
     --plugin-official-background: #594504;
     --plugin-official-text: #f2bd0c;
+    --table-row-bg: #161b22;
+    --table-row-bg-alternate: #0d1117;
+    --table-cell-sep: #3b4554;
 }

src/data/plugins/currency-converter/images/cc_screenshot.png

@@ -3,11 +3,53 @@ id: 18892B7863AC43ABA27859A5A2866DD8
 # Uncomment and fill in relevant sections if you provide videos and/or images
 #videos:
 #- https://youtu.be/dQw4w9WgXcQ
-#images:
-#- image1.png
-#- image2.png
-#- image3.png
 tags:
 - Calculators & Converters
 - Finance
 ---
+# Currency Converter (Flow.Launcher.Plugin.Currency)
+
+Currency conversion for the Flow Launcher
+
+![screenshot](images/cc_screenshot.png)
+
+### About
+
+Uses the [European Central Bank](https://www.ecb.europa.eu/stats/policy_and_exchange_rates/euro_reference_exchange_rates/html/index.en.html) daily rates to get and convert currency exchange rates.
+
+Currency code that can be used are:
+
+'AUD' , 'BGN' , 'BRL' , 'CAD' , 'CHF' , 'CNY' , 'CZK' , 'DKK' , 'GBP', 'HKD' , 'HRK' , 'HUF' , 'IDR' , 'ILS' , 'INR' , 'ISK' , 'JPY' , 'KRW', 'MXN', 'MYR' , 'NOK' , 'NZD' , 'PHP' , 'PLN' , 'RON' , 'RUB' , 'SEK', 'SGD' , 'THB' , 'TRY' , 'USD' , 'ZAR' , 'EUR'
+
+### Requirements
+
+Flow Launcher should take care of the installation of Python for you if it is not on your system, as well as the libraries needed by this plugin.
+
+You must be online when you run the plugin in Flow to download the currency XML file, or you will get a connection error. A local copy of the local XML file from a previous download can be used if it exists.
+
+### Plugin Settings
+
+Type `settings` in Flow to access the Flow settings window, then go to Plugins - Currency Converter
+
+__Keyword (default 'cc')__ - change this to set a new keyword to activate the plugin
+
+__File age (default 6)__ - the age in hours for the local copy of the rates file to be used before the plugin downloads a fresh copy
+
+### Localisation
+
+Currently English and Chinese language supported. Edit the .env file to change the language.
+
+### Usage
+
+| Keyword                                                          | Description                                 |
+| ---------------------------------------------------------------- | ------------------------------------------- |
+| `cc {amount} {source currency code} {destination currency code}` | Convert amount from source to dest currency |
+
+When typing the source or destination currency the plugin will show what currencies are available.
+
+Decimal precision is based on the input amount however the base rate is always a minimum of three decimal places.
+
+### Problems, errors and feature requests
+
+Open an issue in the plugin repo.
+