docs: Update ReadMe
Update the ReadMe to match the current state of the project.
This commit is contained in:
parent
1076cd2895
commit
96fa327425
16
ReadMe.md
16
ReadMe.md
|
|
@ -5,8 +5,7 @@ formatting numbers manually.
|
|||
|
||||
## Usage
|
||||
- Host the script somewhere on your system.
|
||||
- Ensure you set the language for your HTML\
|
||||
(this will be essential with the first official release.)
|
||||
- Ensure you set the language for your HTML element
|
||||
- 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
|
||||
- Surround any numbers you want formatting with `<num> .. </num>` tags.\
|
||||
|
|
@ -42,14 +41,25 @@ formatting numbers manually.
|
|||
|
||||
## TODO:
|
||||
- Add support for currency formatting
|
||||
- Change language/locale to use document language tag.
|
||||
- Check for optimisations
|
||||
- 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\
|
||||
I personally don't care for minified JS but some people love it\
|
||||
This is an extremely low-priority task.
|
||||
|
||||
## Changelog
|
||||
- 2022-10-08\
|
||||
Get language from DOM
|
||||
Robert Morrison \<sherlock5512\>
|
||||
- 2022-10-07{2}\
|
||||
Add Logo\
|
||||
Robert Morrison \<sherlock5512\>
|
||||
- 2022-10-07\
|
||||
Initial Upload of basic script\
|
||||
Robert Morrison \<sherlock5512\>
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user