Add keywords and readme
This commit is contained in:
parent
ed2c9caddf
commit
cccf9c1893
|
|
@ -0,0 +1,25 @@
|
|||
# Numeric Types
|
||||
|
||||
A typescript library that aims to provide performant arithmetic types.
|
||||
|
||||
# Limitations
|
||||
|
||||
Currently numeric-types does not support negative numbers, decimals, or bigints.
|
||||
|
||||
# Types
|
||||
|
||||
### Add<A extends number, B extends number>
|
||||
|
||||
Resolves to the sum of A and B
|
||||
|
||||
### Max<A extends number, B extends number>
|
||||
|
||||
Resolves to the larger of A and B
|
||||
|
||||
# Current Roadmap
|
||||
|
||||
- Subtraction
|
||||
- Support negative numbers
|
||||
- Support decimal numbers
|
||||
- Multiplication
|
||||
- Division
|
||||
|
|
@ -10,5 +10,6 @@
|
|||
"license": "NON-AI ISC",
|
||||
"dependencies": {
|
||||
"typescript": "^5.3.3"
|
||||
}
|
||||
},
|
||||
"keywords": ["typescript", "math", "numeric", "add", "max"]
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue