smath 1.3.0 → 1.3.2

package/README.md

@@ -1,8 +1,8 @@
-[Home](/) | [Docs](https://npm.nicfv.com/smath/) | [GitHub](https://github.com/nicfv/npm/tree/main/smath/) | [npm](https://www.npmjs.com/package/smath) | [Changelog](https://github.com/nicfv/npm/blob/main/smath//CHANGELOG.md) | [YouTube](https://www.youtube.com/@nciv) | Small math function library
+[Home](../) | [Docs](https://npm.nicfv.com/smath/) | [GitHub](https://github.com/nicfv/npm/tree/main/smath/) | [npm](https://www.npmjs.com/package/smath) | [Changelog](https://github.com/nicfv/npm/blob/main/smath//CHANGELOG.md) | [YouTube](https://www.youtube.com/@nciv) | Small math function library
 
 ![NPM Downloads](https://img.shields.io/npm/dt/smath)
 ![NPM Version](https://img.shields.io/npm/v/smath)
-![Relative date](https://img.shields.io/date/1711134970)
+![Relative date](https://img.shields.io/date/1711214231)
 ![GitHub watchers](https://img.shields.io/github/watchers/nicfv/npm)
 ![GitHub forks](https://img.shields.io/github/forks/nicfv/npm)
 ![GitHub Repo stars](https://img.shields.io/github/stars/nicfv/npm)
@@ -12,7 +12,7 @@
 smath can be installed from the official [npm package repository](https://www.npmjs.com/package/smath). It is highly recommended to install the latest version, which is installed by default with the following command.
 
 ```shell
-npm i smath@1.3.0
+npm i smath@1.3.2
 ```
 
 ## Bugs and Requests
@@ -24,14 +24,24 @@ Is there a way we can make smath better? Please report all bugs, issues, and new
 Thank you for your interest in contributing to smath! smath is an open source software package maintained by Nicolas Ventura ([@nicfv](https://github.com/nicfv)) and built by users like you! You are allowed to fork the repository as permitted by the [MIT License](https://raw.githubusercontent.com/nicfv/npm/main/LICENSE) terms. Contributions are welcome by submitting a [pull request](https://github.com/nicfv/npm/pulls). Please follow the existing code styling if submitting a pull request. Thank you for your consideration!
 ## Getting Started
 
-Similar to JavaScript's builtin [`Math`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math) object, `SMath` exports one global object with several math-related helper functions. There is no need to instantiate the class, just call functions directly. See the examples below to get started using SMath!
-
-## Example
-
-Here are a few examples written in JavaScript for a quick start into `SMath`.
-
+Small math? Simple math? Or supplemental math? Canonically, "SMath" is pronounced "smath" and stands for "small math (library.)" Similar to JavaScript's builtin [`Math`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math) object, `SMath` exports one global object with several math-related helper functions. There is no need to instantiate the class, just call functions directly. See the examples below to get started using SMath!
+## Examples
+Here are a few quickstart examples written in JavaScript that showcase some out-of-box features of the `smath` package.
 ### JavaScript Math Oddities
-
+Sometimes, JavaScript does weird math! Try adding `0.1 + 0.2` in your NodeJS terminal. What did you get?
+
+> Hint: It's not 0.3!
+
+The function `SMath.approx()` is an attempt to mitigate some of the issues that arise when doing arithmetic with non-whole numbers.
+#### Instructions
+1. Copy the source code
+1. Paste into a new file
+1. Save as `JavaScript-Math-Oddities.mjs`
+1. Run this command in your terminal
+    ```shell
+    node JavaScript-Math-Oddities.mjs
+    ```
+#### Source
 ```js
 import { SMath } from 'smath';
 
@@ -39,16 +49,22 @@ import { SMath } from 'smath';
 console.log('0.1 + 0.2 == 0.3 is ' + (0.1 + 0.2 == 0.3));
 console.log('SMath.approx(0.1 + 0.2, 0.3) is ' + SMath.approx(0.1 + 0.2, 0.3));
 ```
-
+#### Output
 ```text
 0.1 + 0.2 == 0.3 is false
 SMath.approx(0.1 + 0.2, 0.3) is true
 ```
-
 ### Temperature Conversion
-
-A temperature conversion tool using [`SMath.translate`](https://npm.nicfv.com/smath/classes/SMath.html#translate) to convert units. The translation uses freezing and boiling points for 2 unit systems to linearly interpolate between them.
-
+This example demonstrates a simple temperature converter from Celsius to Fahrenheit, using `SMath.translate()` to linearly interpolate between unit systems. The translation uses freezing and boiling points to fix the bounds of the linear interpolation.
+#### Instructions
+1. Copy the source code
+1. Paste into a new file
+1. Save as `Temperature-Conversion.mjs`
+1. Run this command in your terminal
+    ```shell
+    node Temperature-Conversion.mjs
+    ```
+#### Source
 ```js
 import { SMath } from 'smath';
 
@@ -80,7 +96,7 @@ for (let i = 0; i < C.length; i++) {
     console.log(C[i].toFixed() + 'C is ' + F[i].toFixed() + 'F')
 }
 ```
-
+#### Output
 ```text
 0C is 32F
 5C is 41F

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "smath",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Small math function library",
   "homepage": "https://npm.nicfv.com/smath",
-  "bin": "dist/src/bin.js",
-  "main": "dist/src/index.js",
-  "types": "types/src/index.d.ts",
+  "bin": "dist/bin.js",
+  "main": "dist/index.js",
+  "types": "types/index.d.ts",
   "files": [
-    "dist/src",
-    "types/src"
+    "dist",
+    "types"
   ],
   "scripts": {
     "build": "rm -rf dist && tsc",
-    "test": "npm run build && node dist/test/index.js",
+    "test": "tsc --noEmit # tsc --outDir tmp test/index.ts && { node tmp/test/index.js ; rm -r tmp ; }",
     "clean": "rm -rf node_modules package-lock.json dist types docs",
     "docs": "rm -rf docs && typedoc --includeVersion --disableSources --hideGenerator src",
     "prepack": "npm run build",
@@ -49,7 +49,6 @@
   "devDependencies": {
     "@types/node": "20.11.30",
     "typedoc": "0.25.12",
-    "typescript": "5.4.3",
-    "xpt": "0.2.0"
+    "typescript": "5.4.3"
   }
 }