Add keywords and readme

This commit is contained in:
Jeff 2024-02-28 22:53:11 -05:00
parent ed2c9caddf
commit cccf9c1893
2 changed files with 27 additions and 1 deletions

25
README.md Normal file
View File

@ -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

View File

@ -10,5 +10,6 @@
"license": "NON-AI ISC",
"dependencies": {
"typescript": "^5.3.3"
}
},
"keywords": ["typescript", "math", "numeric", "add", "max"]
}