math-wizard 1.0.0 → 1.0.2

package/Readme

@@ -0,0 +1,64 @@
+# math-wizard
+
+`math-wizard` is a tiny TypeScript-based npm package for performing simple numeric addition. It is designed to be easy to install and use in modern ESM-compatible JavaScript and TypeScript projects.
+
+## Features
+
+- Add two numbers with a single function
+- TypeScript-friendly API with type declarations
+- ESM-compatible package entry point
+- Minimal dependency footprint
+- Simple installation and usage
+
+## Installation
+
+```bash
+npm install math-wizard
+```
+
+## Usage
+
+```ts
+import { add } from 'math-wizard';
+
+const result = add(2, 3);
+console.log(result); // 5
+```
+
+## Examples
+
+### Basic addition
+
+```ts
+import { add } from 'math-wizard';
+
+console.log(add(10, 15));
+// Output: 25
+```
+
+### Using the function in a TypeScript file
+
+```ts
+import { add } from 'math-wizard';
+
+function sumValues(a: number, b: number) {
+  return add(a, b);
+}
+
+console.log(sumValues(4, 7));
+// Output: 11
+```
+
+## API
+
+### `add(a, b)`
+
+- `a`: number
+- `b`: number
+- returns: number
+
+Adds two numeric values and returns the sum.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+export declare const add: (a: number, b: number) => number;

package/dist/index.js

@@ -0,0 +1,3 @@
+export const add = (a, b) => {
+    return a + b;
+};

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "math-wizard",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "a package that enables you to add numbers",
-  "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc",
+    "prepublish": "npm run build"
   },
   "keywords": [
     "add",
@@ -13,7 +13,19 @@
   ],
   "author": "Moe",
   "license": "MIT",
-  "type": "commonjs",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {},
   "dependencies": {
     "typescript": "^6.0.2"
   }

package/index.ts

@@ -1,5 +0,0 @@
-function add(a: number, b: number) {
-  return a + b;
-};
-
-export default add;