From cccf9c18938647c3f35fb820a209dc86f6a332d0 Mon Sep 17 00:00:00 2001
From: Jeff <jeff.m.lieb@gmail.com>
Date: Wed, 28 Feb 2024 22:53:11 -0500
Subject: [PATCH] Add keywords and readme

---
 README.md    | 25 +++++++++++++++++++++++++
 package.json |  3 ++-
 2 files changed, 27 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8057d1c
--- /dev/null
+++ b/README.md
@@ -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
\ No newline at end of file
diff --git a/package.json b/package.json
index f4ecd26..e035e8a 100644
--- a/package.json
+++ b/package.json
@@ -10,5 +10,6 @@
   "license": "NON-AI ISC",
   "dependencies": {
     "typescript": "^5.3.3"
-  }
+  },
+  "keywords": ["typescript", "math", "numeric", "add", "max"]
 }