refactor: unify API design style and enhance interoperability between packages

Author: DemoMacro

README.md

@@ -5,12 +5,74 @@
 
 > Natural language processing tools, powered by Demo Macro.
 
+## Introduction
+
+NLPTools is a comprehensive collection of natural language processing utilities designed to simplify text analysis, comparison, and manipulation. The project is structured as a monorepo with multiple specialized packages that can be used together or independently.
+
+## Features
+
+- **Text Similarity**: Multiple algorithms for measuring text similarity (Levenshtein, Jaccard, Cosine)
+- **Text Comparison**: Tools for comparing and finding differences between texts
+- **Text Segmentation**: Utilities for breaking text into paragraphs, sentences, phrases, and words
+- **Language Support**: Support for multiple languages with automatic language detection
+- **Modular Design**: Use only what you need with independent packages
+
+## Installation
+
+```bash
+# Install the main package with all utilities
+pnpm install @nlptools/nlptools
+
+# Or install individual packages as needed
+pnpm install @nlptools/similarity
+pnpm install @nlptools/comparison
+pnpm install @nlptools/segmentation
+pnpm install @nlptools/core
+```
+
+## Quick Start
+
+```ts
+// Import from the main package
+import {
+  createSimilarityMeasure,
+  createComparator,
+  createSegmenter,
+} from "@nlptools/nlptools";
+
+// Calculate text similarity
+const similarity = createSimilarityMeasure("levenshtein").calculate(
+  "Hello world",
+  "Hello there",
+);
+console.log(`Similarity: ${similarity.similarity}`);
+
+// Compare texts and get differences
+const diff = createComparator("diff").compare("Hello world", "Hello there");
+console.log(diff.differences);
+
+// Segment text into sentences
+const sentences = createSegmenter("sentences").segment(
+  "Hello world! How are you today?",
+);
+console.log(sentences.segments);
+```
+
 ## Packages
 
-- [nlptools](./packages/nlptools/README.md)
-- [@nlptools/comparison](./packages/comparison/README.md)
-- [@nlptools/segmentation](./packages/segmentation/README.md)
-- [@nlptools/similarity](./packages/similarity/README.md)
+- [nlptools](./packages/nlptools/README.md) - Main package that includes all modules
+- [@nlptools/similarity](./packages/similarity/README.md) - Text similarity algorithms
+- [@nlptools/comparison](./packages/comparison/README.md) - Text comparison utilities
+- [@nlptools/segmentation](./packages/segmentation/README.md) - Text segmentation tools
+- [@nlptools/core](./packages/core/README.md) - Core utilities and interfaces
+
+## Documentation
+
+Each package contains detailed documentation and examples. See the individual package READMEs for more information.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## License
 

biome.json

@@ -8,7 +8,7 @@
   },
   "javascript": {
     "formatter": {
-      "trailingComma": "es5"
+      "trailingCommas": "es5"
     }
   }
 }

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "build": "pnpm -r prepack",
     "dev": "pnpm -r prepack --stub",
-    "check": "biome check . --apply-unsafe && biome format . --write",
+    "check": "biome check . --write --unsafe && biome format . --write",
     "format": "prettier --write --list-different . --ignore-path .gitignore",
     "edge": "pnpm -r exec bump version",
     "release": "pnpm -r exec bump version -r patch",
@@ -38,5 +38,6 @@
     "@types/node": "22.5.3",
     "prettier": "3.3.3",
     "unbuild": "2.0.0"
-  }
+  },
+  "packageManager": "pnpm@10.6.1+sha512.40ee09af407fa9fbb5fbfb8e1cb40fbb74c0af0c3e10e9224d7b53c7658528615b2c92450e74cfad91e3a2dcafe3ce4050d80bda71d757756d2ce2b66213e9a3"
 }