robert/numberformat.js
robert/numberformat.js
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Activity

docs: Update ReadMe

Browse Source 
Update the ReadMe to match the current state of the project.
This commit is contained in:
Robert Morrison 2022-10-08 03:56:10 +01:00
parent 1076cd2895
commit 96fa327425
Signed by: robert
GPG Key ID: 73E012EB3F4EC696
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
ReadMe.md
View File

@ -5,8 +5,7 @@ formatting numbers manually.
## Usage ## Usage
- Host the script somewhere on your system. - Host the script somewhere on your system.
- Ensure you set the language for your HTML\ - Ensure you set the language for your HTML element
(this will be essential with the first official release.)
- Add a script tag to your document head that has the `src` set to this script.\ - Add a script tag to your document head that has the `src` set to this script.\
The script tag must also be set to defer The script tag must also be set to defer
- Surround any numbers you want formatting with `<num> .. </num>` tags.\ - Surround any numbers you want formatting with `<num> .. </num>` tags.\
@ -42,14 +41,25 @@ formatting numbers manually.
## TODO: ## TODO:
- Add support for currency formatting - Add support for currency formatting
- Change language/locale to use document language tag.
- Check for optimisations - Check for optimisations
- If this becomes popular host to a CDN - If this becomes popular host to a CDN
- Change custom element\
Technically the WHATWG specifies that custom elements should be in
kebab case.
## MightDO:
- Allow for setting locale for individual numbers.
- Automate releases that include a minified version\ - Automate releases that include a minified version\
I personally don't care for minified JS but some people love it\ I personally don't care for minified JS but some people love it\
This is an extremely low-priority task. This is an extremely low-priority task.
## Changelog ## Changelog
- 2022-10-08\
Get language from DOM
Robert Morrison \<sherlock5512\>
- 2022-10-07{2}\
Add Logo\
Robert Morrison \<sherlock5512\>
- 2022-10-07\ - 2022-10-07\
Initial Upload of basic script\ Initial Upload of basic script\
Robert Morrison \<sherlock5512\> Robert Morrison \<sherlock5512\>