add readme

mmmurray · Dec 21, 2022 · bc6fafe · bc6fafe
1 parent 16d2752
commit bc6fafe
Showing 1 changed file with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,25 @@
 # Mantissa
 
-Mathematical functions.
+TypeScript library of pure mathematical utility functions.
+
+## Install
+
+```console
+yarn add mantissa
+```
+
+Or
+
+```console
+npm i mantissa
+```
+
+## Usage
+
+```ts
+import { vec2, vec2Add } from 'mantissa';
+
+const a = vec2(1, 2);
+const b = vec2(3, 4);
+const c = vec2Add(a, b);
+```