docs: update README.md

This commit is contained in:
2025-06-18 13:43:45 +03:00
parent 22987bd734
commit b2ad9d904c
2 changed files with 15 additions and 4 deletions

View File

@@ -21,15 +21,26 @@ Interval for fetch may be adjusted in the admin settings "Auto Currency" section
## Preparing currency data
For both main and additional currencies, you must include in the currency name, one of the
following:
To make sure your currencies are found for the rates to be updated, please ensure your currencies
are named appropriately.
For both main and additional currencies, Currency names must contain **at least one of**:
- Currency symbol (`$`, `€`, `£`, etc.)
- Currency code (USD, EUR, GBP, etc.) - case insensitive
Using one of these will be enough to fetch the correct rate.
For a full list of available currencies, see [symbols.json](lib/Service/symbols.json).
Example working names:
-`$`
-`USD`
-`$ USD`
-`US Dollar`
-`United States Dollar`
For a full list of available currencies, see [symbols.json](lib/Service/symbols.json), or refer to
the table in the app's settings screen.
## Installation

View File

@@ -11,7 +11,7 @@
"dev": "vite build --watch",
"build": "vue-tsc -b && vite build",
"lint": "eslint src",
"format": "eslint --fix src && prettier --write src",
"format": "eslint --fix src && prettier --write {src/,README.md}",
"prepare": "husky",
"gen": "simple-scaffold -c . -k"
},