diff --git a/README.md b/README.md index 8057d1c..f714bbf 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ -# Numeric Types +# Math Types A typescript library that aims to provide performant arithmetic types. # Limitations -Currently numeric-types does not support negative numbers, decimals, or bigints. +Currently math-types does not support negative numbers, decimals, or bigints. # Types ### Add Resolves to the sum of A and B +The corresponding function `add` uses this type ### Max Resolves to the larger of A and B +The corresponding function `max` uses this type # Current Roadmap diff --git a/package.json b/package.json index e035e8a..31cc758 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "numeric-types", + "name": "math-types", "version": "0.0.1", "description": "", "main": "index.js", @@ -11,5 +11,5 @@ "dependencies": { "typescript": "^5.3.3" }, - "keywords": ["typescript", "math", "numeric", "add", "max"] + "keywords": ["typescript", "math", "add", "max"] }