uconvert 0.1.4 → 0.1.6

package/README.md

@@ -2,8 +2,27 @@
 
 Lightweight utility for converting common measurement units.
 
-
-
+<br />
+
+## Table of contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [`convert(value, options)`](#convertvalue-options)
+  - [`round(value, decimalPlaces?)`](#roundvalue-decimalplaces)
+- [Exported types and enums](#exported-types-and-enums)
+- [Supported units](#supported-units)
+  - [Length](#length)
+  - [Weight](#weight)
+  - [Speed](#speed)
+  - [Temperature](#temperature)
+- [Height utility](#height-utility)
+  - [`height.toFeetInches(valueInCm, roundTo?)`](#heighttofeetinchesvalueincm-roundto)
+  - [`height.toCentimeters(feetInches)`](#heighttocentimetersfeetinches)
+  - [`height.parseFeetInches(input)`](#heightparsefeetinchesinput)
+  - [`FeetInches` type](#feetinches-type)
+
+<br />
 
 ## Installation
 
@@ -11,13 +30,11 @@ Lightweight utility for converting common measurement units.
 npm install uconvert
 ```
 
-
-
+<br />
 
 ## Usage
 
-
-
+<br />
 
 ### `convert(value, options)`
 
@@ -51,8 +68,7 @@ convert(100, { fromUnits: MetricUnits.CM, toUnits: MetricUnits.CM });
 // => 100
 ```
 
-
-
+<br />
 
 ### `round(value, decimalPlaces?)`
 
@@ -74,15 +90,32 @@ round(1.2345, 2); // => 1.23
 round(1.2345); // => 1.2345
 ```
 
+<br />
 
+## Exported types and enums
 
+Use these with `convert` for type-safe unit arguments:
 
-## Supported units
+| Export           | Description                                                                          |
+| ---------------- | ------------------------------------------------------------------------------------ |
+| `ConvertOptions` | Options object for `convert`: `{ fromUnits, toUnits, roundTo? }`.                    |
+| `Units`          | Union type: `MetricUnits \| ImperialUnits`.                                          |
+| `MetricUnits`    | Enum: `MM`, `CM`, `M`, `KM`, `G`, `KG`, `TONNE`, `CELSIUS`, `KELVIN`, `M_S`, `KM_H`. |
+| `ImperialUnits`  | Enum: `IN`, `FT`, `YD`, `MI`, `OZ`, `LB`, `ST`, `FAHRENHEIT`, `FT_S`, `MPH`.         |
+| `UnitSystem`     | Enum: `METRIC`, `IMPERIAL`.                                                          |
+| `Dimension`      | Enum: `LENGTH`, `WEIGHT`, `SPEED`, `TEMPERATURE`.                                    |
 
-Units are grouped by dimension. Use the **Code** value with `convert()`.
+`fromUnits` and `toUnits` must use the same dimension (e.g. both length, or both weight); otherwise `convert` throws.
 
+---
+
+<br />
 
+## Supported units
 
+Units are grouped by dimension. Use the **Code** value with `convert()`.
+
+<br />
 
 ### Length
 
@@ -97,8 +130,7 @@ Units are grouped by dimension. Use the **Code** value with `convert()`.
 | yd   | `ImperialUnits.YD` | Imperial |
 | mi   | `ImperialUnits.MI` | Imperial |
 
-
-
+<br />
 
 ### Weight
 
@@ -111,8 +143,7 @@ Units are grouped by dimension. Use the **Code** value with `convert()`.
 | lb   | `ImperialUnits.LB`  | Imperial |
 | st   | `ImperialUnits.ST`  | Imperial |
 
-
-
+<br />
 
 ### Speed
 
@@ -123,8 +154,7 @@ Units are grouped by dimension. Use the **Code** value with `convert()`.
 | ft/s | `ImperialUnits.FT_S` | Imperial |
 | mph  | `ImperialUnits.MPH`  | Imperial |
 
-
-
+<br />
 
 ### Temperature
 
@@ -137,24 +167,11 @@ Units are grouped by dimension. Use the **Code** value with `convert()`.
 
 
 
-## Exported types and enums
-
-Use these with `convert` for type-safe unit arguments:
-
-| Export           | Description                                                                          |
-| ---------------- | ------------------------------------------------------------------------------------ |
-| `ConvertOptions` | Options object for `convert`: `{ fromUnits, toUnits, roundTo? }`.                    |
-| `Units`          | Union type: `MetricUnits \| ImperialUnits`.                                          |
-| `MetricUnits`    | Enum: `MM`, `CM`, `M`, `KM`, `G`, `KG`, `TONNE`, `CELSIUS`, `KELVIN`, `M_S`, `KM_H`. |
-| `ImperialUnits`  | Enum: `IN`, `FT`, `YD`, `MI`, `OZ`, `LB`, `ST`, `FAHRENHEIT`, `FT_S`, `MPH`.         |
-| `UnitSystem`     | Enum: `METRIC`, `IMPERIAL`.                                                          |
-| `Dimension`      | Enum: `LENGTH`, `WEIGHT`, `SPEED`, `TEMPERATURE`.                                    |
-
-`fromUnits` and `toUnits` must use the same dimension (e.g. both length, or both weight); otherwise `convert` throws.
+<br />
 
 ---
 
-
+<br />
 
 
 ## Height utility
@@ -167,8 +184,7 @@ The `height` object provides helpers for converting between centimeters and feet
 import { height } from "uconvert";
 ```
 
-
-
+<br />
 
 ### `height.toFeetInches(valueInCm, roundTo?)`
 
@@ -188,8 +204,7 @@ height.toFeetInches(170); // => [5, 6.93...]
 height.toFeetInches(170, 1); // => [5, 6.9]
 ```
 
-
-
+<br />
 
 ### `height.toCentimeters(feetInches)`
 
@@ -207,8 +222,7 @@ Converts a feet–inches tuple to centimeters.
 height.toCentimeters([5, 10]); // => 177.8
 ```
 
-
-
+<br />
 
 ### `height.parseFeetInches(input)`
 
@@ -228,8 +242,7 @@ height.parseFeetInches("5'10\""); // => [5, 10]
 height.parseFeetInches("6 2"); // => [6, 2]
 ```
 
-
-
+<br />
 
 ### `FeetInches` type
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "uconvert",
-  "version": "0.1.4",
-  "description": "",
+  "version": "0.1.6",
+  "description": "A lightweight TypeScript utility to convert measurements between unit systems like metric and imperial.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -58,7 +58,7 @@
     "precision",
     "cross-units"
   ],
-  "author": "",
+  "author": "Andrii Tkachuk",
   "license": "MIT",
   "type": "commonjs",
   "bugs": {