smart-unit 1.0.3 → 1.0.4

package/README.md

@@ -5,6 +5,7 @@
 [![npm version](https://img.shields.io/npm/v/smart-unit)](https://www.npmjs.com/package/smart-unit)
 [![npm downloads](https://img.shields.io/npm/dm/smart-unit)](https://www.npmjs.com/package/smart-unit)
 [![bundle size](https://img.shields.io/bundlephobia/minzip/smart-unit)](https://bundlephobia.com/package/smart-unit)
+[![test](https://github.com/flycran/smart-unit/workflows/Test/badge.svg)](https://github.com/flycran/smart-unit/actions)
 [![license](https://img.shields.io/npm/l/smart-unit)](./LICENSE)
 
 English | [中文](./README.zh-CN.md)
@@ -13,6 +14,16 @@ English | [中文](./README.zh-CN.md)
 
 **smart-unit** is a lightweight utility for automatic unit conversion with intelligent formatting.
 
+```ts
+import SmartUnit from 'smart-unit';
+
+const size = new SmartUnit(['B', 'KB', 'MB', 'GB'], { baseDigit: 1024 });
+
+size.format(1024 * 1024 * 100);  // "100MB"
+size.format(1536);               // "1.5KB"
+size.parse('2.5GB');             // 2684354560
+```
+
 ## Features
 
 - 🎯 **Smart Formatting** — Automatically selects the optimal unit for display
@@ -21,6 +32,7 @@ English | [中文](./README.zh-CN.md)
 - 🧮 **High Precision** — Optional `decimal.js` integration for arbitrary precision
 - 📦 **TypeScript First** — Full type safety
 - 🪶 **Lightweight** — Core functionality with minimal footprint
+- ✅ **Well Tested** — Comprehensive test suite with 100% coverage
 
 ## Install
 
@@ -104,7 +116,7 @@ Formats a number to the optimal unit string.
 ```ts
 const size = new SmartUnit(['B', 'KB', 'MB'], { baseDigit: 1024, fractionDigits: 2 });
 
-size.format(1536);           // => "1.5KB"
+size.format(1536);           // => "1.50KB"
 size.format(1536, 0);        // => "2KB"
 size.format(1536, '1-3');    // => "1.5KB" (min 1, max 3 decimals)
 ```
@@ -203,6 +215,14 @@ const currency = new SmartUnit(['', 'K', 'M', 'B', 'T'], {
 currency.format('12345678901234567890');  // => "12345678.90T"
 ```
 
+## Testing
+
+Run the test suite:
+
+```bash
+npm test
+```
+
 ## TypeScript
 
 smart-unit is written in TypeScript and provides full type safety.

package/README.zh-CN.md

@@ -5,6 +5,7 @@
 [![npm version](https://img.shields.io/npm/v/smart-unit)](https://www.npmjs.com/package/smart-unit)
 [![npm downloads](https://img.shields.io/npm/dm/smart-unit)](https://www.npmjs.com/package/smart-unit)
 [![bundle size](https://img.shields.io/bundlephobia/minzip/smart-unit)](https://bundlephobia.com/package/smart-unit)
+[![test](https://github.com/flycran/smart-unit/workflows/Test/badge.svg)](https://github.com/flycran/smart-unit/actions)
 [![license](https://img.shields.io/npm/l/smart-unit)](./LICENSE)
 
 [English](./README.md) | 中文
@@ -13,6 +14,16 @@
 
 **smart-unit** 是一个轻量级的自动单位转换工具，支持智能格式化输出。
 
+```ts
+import SmartUnit from 'smart-unit';
+
+const size = new SmartUnit(['B', 'KB', 'MB', 'GB'], { baseDigit: 1024 });
+
+size.format(1024 * 1024 * 100);  // "100MB"
+size.format(1536);               // "1.5KB"
+size.parse('2.5GB');             // 2684354560
+```
+
 ## 特性
 
 - 🎯 **智能格式化** — 自动选择最优单位进行展示
@@ -21,6 +32,7 @@
 - 🧮 **高精度** — 可选 `decimal.js` 集成，支持任意精度计算
 - 📦 **TypeScript 优先** — 完整的类型安全
 - 🪶 **轻量级** — 核心功能，体积小巧
+- ✅ **测试完善** — 全面的测试套件，100% 覆盖率
 
 ## 安装
 
@@ -104,7 +116,7 @@ time.parse('2.5h');  // => 9000000 (ms)
 ```ts
 const size = new SmartUnit(['B', 'KB', 'MB'], { baseDigit: 1024, fractionDigits: 2 });
 
-size.format(1536);           // => "1.5KB"
+size.format(1536);           // => "1.50KB"
 size.format(1536, 0);        // => "2KB"
 size.format(1536, '1-3');    // => "1.5KB"（最少1位，最多3位小数）
 ```
@@ -203,6 +215,14 @@ const currency = new SmartUnit(['', 'K', 'M', 'B', 'T'], {
 currency.format('12345678901234567890');  // => "12345678.90T"
 ```
 
+## 测试
+
+运行测试套件：
+
+```bash
+npm test
+```
+
 ## TypeScript
 
 smart-unit 使用 TypeScript 编写，提供完整的类型安全。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smart-unit",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Elegant unit conversion utility with automatic unit selection and high-precision support",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -59,4 +59,4 @@
   "dependencies": {
     "decimal.js": "^10.5.0"
   }
-}
+}