@danielhaim/titlecaser 1.7.12 → 1.7.14

package/README.md

@@ -4,430 +4,300 @@
 [![Downloads](https://img.shields.io/npm/dt/@danielhaim/titlecaser.svg)](https://www.npmjs.com/package/@danielhaim/titlecaser)
 ![GitHub](https://img.shields.io/github/license/danielhaim1/titlecaser)
 
-A powerful utility for converting text to title case with support for multiple style guides and extensive customization options.
+A style-guide–aware title case engine for JavaScript that implements **AP**, **APA**, **Chicago**, **NYT**, **Wikipedia**, and **British** styles with contextual acronym disambiguation and 1,000+ curated domain terms.
 
 <a target="_blank" href="https://danielhaim1.github.io/TitleCaser/"><img src="https://raw.githubusercontent.com/danielhaim1/TitleCaser/main/docs/assets/demo.png" width="100%" height="auto" alt="TitleCaser Demo"></a>
 
-- [TitleCaser](#titlecaser)
-  * [Demo](https://danielhaim1.github.io/TitleCaser/)
-  * [CodePen Demo 1](https://codepen.io/danielhaim/pen/oNQgjBv)
-  * [CodePen Demo 2](https://codepen.io/danielhaim/pen/oNPGzKw)
-  * [Table of Contents](#table-of-contents)
-  * [Introduction](#introduction)
-  * [Key Features:](#key-features)
-  * [Installation](#installation)
-  * [Usage](#usage)
-  * [Usage in the Browser](#usage-in-the-browser)
-  * [Options](#options)
-  * [Methods](#methods)
-  * [Examples](#examples)
-    + [Basic Usage](#basic-usage)
-    + [Customizing Word Replacements Method](#customizing-word-replacements-method)
-    + [Customizing TitleCaser](#customizing-titlecaser)
-    + [TitleCaser with Default Word Replacement](#titlecaser-with-default-word-replacement)
-    + [TitleCaser with Possessive Noun and a Colon](#titlecaser-with-possessive-noun-and-a-colon)
-  * [Build Process](#build-process)
-  * [Test](#test)
-  * [Resources](#resources)
-  * [Report Bugs](#report-bugs)
-  * [Contributing](CONTRIBUTING.md)
-  * [Changelog](CHANGELOG.md)
-
-## Overview
-
-TitleCaser is a comprehensive solution for converting text to title case according to various style guides (AP, APA, Chicago, NYT, Wikipedia, British). It handles special cases like hyphens, apostrophes, Roman numerals, and acronyms, and provides extensive customization options.
-
-## Language Conventions and Style Library
-
-**The comprehensive Language Conventions and Style Library (LCSL)** is specifically designed to assist web content developers in adhering to the latest style guides and English language conventions. This all-inclusive library has various features, including support for numerous style guides such as **AP, APA, Chicago, NY Times, Wikipedia, and British styles** and customizable preferences to tailor to individual needs. **TitleCaser is a component of this library**, and LCSL is set to be open-sourced by the end of 2025.
-
-### Streamlined Workflow
-To streamline workflow, modules are available in both **browser and node environment versions** and include a command-line interface for building, testing, and minimizing the module. Additionally, it features a **filter ability** that allows users to ignore certain phrases containing short words, preventing the module from mistakenly flagging instances where short words are used as part of a larger term or phrase.
-
-### Comprehensive Capitalization Handling
-The module has been designed to handle various capitalization scenarios, including:
-- **Hyphenated words**
-- **Prefixes and suffixes**
-- **Reserved words**
-- **Roman numerals**
-- **Proper nouns** that contain lowercase letters
-- **Words that require capitalization** in specific contexts
-
-This ensures that your content meets the appropriate style and formatting guidelines, regardless of the context. It also offers **word replacement capabilities**, as well as **ignored phrases** to create consistency in cases where certain terms may be capitalized differently depending on the context.
-
-### Essential Tool for Content Developers
-Whether you're developing web content for a major news organization or simply looking to improve your writing skills, this module is an **essential tool** that can help ensure your work is accurate, consistent, and conforms to the latest style guidelines.
-
-### Key Features:
-- **Support for popular style guides** and customizable preferences
-- **Advanced capitalization handling** for suffixes, prefixes, hyphenated words, and reserved words
-- **Support for proper capitalization** of Roman numerals and exclusion of specific words and phrases from title capitalization
-- **Word replacement capabilities** for consistency in capitalization
-- **Command-line interface** for building, testing, and minimizing the module
-- **Pre-defined word lists** for articles, conjunctions, prepositions, and non-capitalized words in titles
-- **Exclusion of common phrases** from title capitalization
-
-## Features
-
-- **Multiple Style Support**: AP, APA, Chicago, NYT, Wikipedia, and British title case styles
-- **Special Case Handling**: Hyphens, apostrophes, Roman numerals, acronyms, and more
-- **Word Replacement**: Replace specific words with their correct forms
-- **Exact Phrase Replacement**: Replace exact phrases with their correct forms
-- **Smart Quotes**: Optional conversion to smart quotes
-- **Extensive Term Lists**: Includes extensive lists of correctly cased terms
-- **Customizable Options**: Customize word lists, replacements, and other options
-
-## Installation
+---
 
-```bash
-npm install @danielhaim/titlecaser
-```
-
-## Usage
+## Links
 
-The package can be imported and used in both Node.js and browser environments:
+- [Demo](https://danielhaim1.github.io/TitleCaser/)
+- [CodePen Demo 1](https://codepen.io/danielhaim/pen/oNQgjBv)
+- [CodePen Demo 2](https://codepen.io/danielhaim/pen/oNPGzKw)
+- [Contributing](CONTRIBUTING.md)
+- [Changelog](CHANGELOG.md)
+- [License](LICENSE)
 
-```javascript
-import { TitleCaser } from '@danielhaim/titlecaser';
-
-// Basic usage with Chicago style
-const titleCaser = new TitleCaser({
-  style: 'chicago'
-});
-const result = titleCaser.toTitleCase('the book   of     life');
-console.log(result); // "The Book of Life"
+---
 
-// With custom options
-const customTitleCaser = new TitleCaser({
-  style: 'ap',
-  smartQuotes: true,
-  ignoredWords: ['a', 'an', 'the'],
-  acronyms: ['API', 'JSON', 'XML']
-});
+## Introduction
 
-const customResult = customTitleCaser.toTitleCase('the api and json data');
-console.log(customResult); // "The API and JSON Data"
+TitleCaser is a deterministic, style-guide–aware title casing engine built for production publishing systems. It implements major editorial standards with rule-driven capitalization logic, including contextual acronym disambiguation, compound handling, possessive normalization, punctuation-aware processing, and curated domain vocabulary enforcement across marketing, academia, business, finance, geography, legal, defense, and technology.
 
-// Add custom word replacements
-titleCaser.addReplaceTerm('js', 'JavaScript');
-const jsResult = titleCaser.toTitleCase('js development');
-console.log(jsResult); // "JavaScript Development"
+Its multi-pass processing architecture ensures deterministic output while supporting custom overrides, exact phrase preservation, and controlled vocabulary enforcement. Designed for Node.js and browser environments, TitleCaser integrates cleanly into CMS pipelines, build systems, and automated editorial workflows where precision and repeatability are required.
 
-// Add exact phrase replacements
-titleCaser.addExactPhraseReplacements([
-  { 'the correct phrase': 'The Correct Phrase' }
-]);
-const phraseResult = titleCaser.toTitleCase('this is the correct phrase');
-console.log(phraseResult); // "This Is The Correct Phrase"
-```
+---
 
-## Usage in the Browser
+## Key Features
 
-The function can also be used in a browser environment by including the `TitleCaser.amd.js` script in your HTML file:
+### Multi-Style Editorial Engine
+Built-in rule systems for **AP**, **APA**, **Chicago**, **NYT**, **Wikipedia** (sentence case), and **British** styles. Each style applies its own logic for minor words, hyphenated compounds, possessives, colon capitalization, and acronym handling, producing consistent, repeatable output.
 
-```html
-<script src="./path/to/TitleCaser.amd.js"></script>
-```
+### Contextual Acronym & Pronoun Disambiguation
+Distinguishes regional acronyms from identical lowercase words using positional and surrounding-word heuristics.
 
-After that, the `toTitleCase()` function can be accessed in your JavaScript code like this:
+For example:
 
 ```javascript
-const options = { 
-  style: 'apa'
-};
-const input = 'the future of devops: the next era';
-const output = input.toTitleCase(options);
+"It’s up to us in the US military to decide."
+→ "It’s Up to Us in the US Military to Decide."
 
-console.log(output); // The Future of DevOps: The Next Era
+"us-uk-led coalition"
+→ "US-UK-Led Coalition"
 ```
 
-### Example with HTML Elements
+- Supports US, UK, EU, USA (dotted and undotted forms)
+- Handles hyphenated compounds (US-Backed, US-UK-Led)
+- Works in parenthetical and comma-separated contexts
+- Detects end-of-sentence acronyms
+- Avoids false positives inside longer words
+
+### Structured Vocabulary Normalization
+Includes **1,000+ curated normalization rules** across brands, technology, geography, business, marketing, defense, academia, finance, and legal domains.
+
+- Mixed-case normalization (`GOOGle → Google`)
+- Intentional lowercase brands (`iPhone`, `eBay`)
+- Roman numerals (`Louis-IV`)
+- Unicode names (`Škoda`)
+- Possessive handling (`GOOGle's tensorflow → Google's TensorFlow`)
+- Runtime custom term overrides
+- Exact phrase replacements
+
+### Advanced Hyphenation & Compound Handling
+Intelligent processing of hyphenated compounds with style-specific rules:
+
+- Multi-hyphen compounds (`US-UK-Led Coalition`)
+- Style-specific compound rules (AP vs Chicago)
+- En dash and em dash normalization
+- Acronym-first compound logic
+- Roman numerals inside compounds
+- Brand casing preservation inside compounds
+
+### Multi-Pass Deterministic Processing
+Layered multi-pass processing for stable handling of complex inputs:
+
+- Input normalization (spacing and `<br>` handling)
+- Token-based whitespace-preserving transformation pipeline
+- Style-aware casing pass
+- Acronym resolution pass
+- Short-word correction pass
+- Final contextual correction pass
+- Optional smart quote conversion
+- Exact phrase override pass
+
+### HTML-Safe & CMS-Ready
+Designed for integration into publishing workflows, CMS pipelines, and automated editorial systems.
+
+- Preserves `<br>` tags
+- Normalizes spacing around colon + `<br>`
+- Retains ampersands and symbols
+- Handles excessive whitespace safely
+- Optional whitespace preservation for editor-safe real-time usage
+
+### Runtime & Build Support
+The AMD/browser build extends `String.prototype.toTitleCase()` for direct string usage in client environments.
+
+- Node.js (ES modules)
+- Browser (prototype extension via AMD build)
+- AMD distribution build
+- CLI build and test scripts
+
+---
+
+## Quick Start
 
-```html
-<h2>nodejs development on aws: an in-depth tutorial on server-side javascript deployment</h2>
-<h2>the iphone's impact on modern communication: a sociolinguistic analysis</h2>
-<h2>back-end and front-end</h2>
+```bash
+npm install @danielhaim/titlecaser
 ```
 
 ```javascript
-function applyTitleCaseToH2Elements(options = { style: "apa" }) {
-  try {
-    const h2Elements = document.querySelectorAll("h2");
-    h2Elements.forEach((h2) => {
-      const innerHTML = h2.innerHTML;
-      const modifiedContent = innerHTML.toTitleCase(options);
-      h2.innerHTML = modifiedContent;
-    });
-  } catch (error) {
-    console.error(
-      "An error occurred while applying title case transformation:",
-      error
-    );
-  }
-}
-
-applyTitleCaseToH2Elements();
-```
-
-## Options
-
-The `{options}` parameter is an object that contains the settings for the conversion process.
+import { TitleCaser } from '@danielhaim/titlecaser';
 
-- `style`: determines the specific title case style to be applied. Permissible values include: `['ap', 'apa', 'british', 'chicago', 'nyt', 'wikipedia']`
-- `articlesList` refers to the words that should be treated as articles in title case.
-- `shortConjunctionsList` pertains to the words that should be treated as short conjunctions in title case.
-- `shortPrepositionsList` relates to the words that should be treated as short prepositions in title case.
-- `neverCapitalizedList` contains the words that should never be capitalized in title case.
-- `wordReplacementsList` is a map of terms that will be replaced during the title case conversion process.
-- `smartQuotes` boolean value that determines whether quotes should be replaced with smart quotes.
+const titleCaser = new TitleCaser({ style: 'ap' });
 
-## Methods
+titleCaser.toTitleCase('the quick brown fox'); // → "The Quick Brown Fox"
+titleCaser.toTitleCase('nodejs development on aws'); // → "Node.js Development on AWS"
+titleCaser.toTitleCase('let us know about the us military'); // → "Let Us Know About the US Military"
+```
 
-- `setReplaceTerms(terms)`: Updates the `wordReplacementsList` with new term-replacement pairs. It accepts an array of objects, each containing a single key-value pair representing the term and its replacement.
-- `removeReplaceTerm(term)`: Removes a replaced term from the `wordReplacementsList` array in the option object of the `TitleCaser` instance. Throws an error if the term is not found in the array, otherwise removes it from the array and updates the option object.
-- `addReplaceTerm(term, replacement)`: Adds a single term-replacement pair to the `wordReplacementsList`. If the term already exists, it updates the replacement value.
-- `addExactPhraseReplacements(newPhrases)` - This method allows adding an array of exact phrase replacements to the `TitleCaser` class. Each item in the array should be an object with a single key-value pair, where the key is the phrase to be replaced and the value is the desired replacement.
-- `setStyle(style: string)`: Sets the style option in the object of the TitleCaser instance. The method takes a string argument style that specifies the style to use for the title casing. If the argument is not a string, the method throws a TypeError. Otherwise, it updates the style option in the object.
-- `smartQuotes(smartQuotes: boolean)`: Specifies whether to replace straight quotes with smart quotes during title casing. Provide a boolean argument smartQuotes to enable or disable this feature.
+---
 
-## Examples
+## Core Usage
 
-### Basic Usage
+### Editorial-Grade Transformation (AP Example)
+Handles brand normalization, acronyms, hyphenation, possessives, and colon rules:
 
 ```javascript
 import { TitleCaser } from '@danielhaim/titlecaser';
 
-const titleCaser = new TitleCaser();
-const result = titleCaser.toTitleCase('hello world');
-console.log(result); // "Hello World"
-```
+const titleCaser = new TitleCaser({ style: 'ap' });
 
-### Customizing Word Replacements Method
+titleCaser.toTitleCase(
+  "nodejs development on aws: an in-depth tutorial on server-side javascript deployment"
+); // → "Node.js Development on AWS: An In-depth Tutorial on Server-side JavaScript Deployment"
+```
 
-In the example below, we create a new instance of the `TitleCaser` class with the `APA` style option. We then set multiple replacement terms using two separate calls to the `setReplaceTerms()` method. Descriptive variable names are used for the input string and expected output. We call `toTitleCase()` to convert the input string to a title case.
+### Custom Term Normalization
+```javascript
+titleCaser.addReplaceTerm('js', 'JavaScript');
+titleCaser.toTitleCase('js development'); // → "JavaScript Development"
+```
 
+### Exact Phrase Replacement
 ```javascript
-import { TitleCaser } from '@danielhaim/titlecaser';
+titleCaser.addExactPhraseReplacements([
+  { 'the correct phrase': 'The Correct Phrase' }
+]);
 
-const titleCaser = new TitleCaser({
-  style: 'apa'
-});
+titleCaser.toTitleCase('this is the correct phrase'); // → "This Is The Correct Phrase"
+```
 
-// Set multiple replacement terms using two separate calls to setReplaceTerms()
-titleCaser.setReplaceTerms({ 
-  'hello world': 'Hello World', 
-  'replace me': 'Replace Me' 
-});
-titleCaser.setReplaceTerms({ 
-  'apa': 'APA' 
+### Smart Quotes
+```javascript
+const tc = new TitleCaser({
+  style: 'ap',
+  smartQuotes: true
 });
 
-// Use descriptive variable names for the input and expected output
-const inputString = "hello world, replace me!";
-const expectedOutput = "Hello World, Replace Me!";
-
-// Call toTitleCase() to convert the input string to title case
-const outputString = titleCaser.toTitleCase(inputString);
+tc.toTitleCase('"never underestimate the power o\' persistence,"'); // → “Never Underestimate the Power O’ Persistence,”
 ```
 
-### Customizing TitleCaser
-
-The example below demonstrates how to use the TitleCaser class to convert a string to a title case with specific settings.
-
-```javascript
-import { TitleCaser } from '@danielhaim/titlecaser';
-
-// Set the options object
-const options = {
-  style: "nyt",
-  wordReplacementsList: {
-    "nodejs": "Node.js",
-    "javascript": "JavaScript",
-    "mongodb": "MongoDB"
-  }
-};
+### Whitespace Normalization
 
-// Instantiate a new TitleCaser object with the options
-const titleCaser = new TitleCaser(options);
+Whitespace normalization is enabled by default.
 
-// Set the input string to be tested
-const input = "the basics of nodejs development with mongodb";
+By default, TitleCaser collapses consecutive whitespace and trims leading and trailing spaces:
 
-// Set the expected output
-const expectedOutput = "The Basics of Node.js Development with MongoDB";
+```javascript
+const tc = new TitleCaser({ style: "ap" });
 
-// Call the toTitleCase method and store the result in actualOutput
-const actualOutput = titleCaser.toTitleCase(input);
+tc.toTitleCase("   the   quick   brown   fox   "); // → "The Quick Brown Fox"
 ```
 
-### TitleCaser with Default Word Replacement
-
-The example below demonstrates how to use the TitleCaser class to convert a string to a title case with AP style formatting, including hyphenated words and word/brand replacement.
+For real-time editors or environments where spacing must be preserved, disable normalization:
 
 ```javascript
-import { TitleCaser } from '@danielhaim/titlecaser';
+const tc = new TitleCaser({
+  style: "ap",
+  normalizeWhitespace: false
+});
 
-// Instantiate a new TitleCaser object with AP style formatting
-const titleCaser = new TitleCaser({ style: 'ap' });
+tc.toTitleCase("   the   quick   brown   fox   "); // → "   The   Quick   Brown   Fox   "
+```
 
-// Set the input string to be tested
-const input = 'nodejs development on aws: an in-depth tutorial on server-side javascript deployment';
+When normalizeWhitespace is false:
+- Internal spacing is preserved
+- Leading/trailing whitespace is preserved
+- Newlines and tabs are preserved
+- Only letter casing is transformed
 
-// Set the expected output
-const expectedOutput = 'Node.js Development on AWS: An In-depth Tutorial on Server-side JavaScript Deployment';
+This behavior allows safe integration into real-time editors without unexpected trimming or cursor instability when normalization is disabled (see [Issue #17](https://github.com/danielhaim1/TitleCaser/issues/17) for discussion).
 
-// Call the toTitleCase method and store the result in actualOutput
-const actualOutput = titleCaser.toTitleCase(input);
+### Browser Usage
+```html
+<script src="./path/to/TitleCaser.amd.js"></script>
 ```
 
-### TitleCaser with Possessive Noun and a Colon
-
-The example below demonstrates how to use the TitleCaser class to convert a string to title case with AP style formatting, including a possessive noun and a colon.
-
 ```javascript
-import { TitleCaser } from '@danielhaim/titlecaser';
-
-// Instantiate a new TitleCaser object with AP style formatting
-const titleCaser = new TitleCaser({ style: "ap" });
+const output = "the future of devops: the next era"
+  .toTitleCase({ style: 'apa' });
 
-// Set the input string to be tested
-const input = "the iphone's impact on modern communication: a sociolinguistic analysis";
-
-// Set the expected output
-const expectedOutput = "The iPhone's Impact on Modern Communication: A Sociolinguistic Analysis";
-
-// Call the toTitleCase method and store the result in actualOutput
-const actualOutput = titleCaser.toTitleCase(input);
+console.log(output); // → "The Future of DevOps: The Next Era"
 ```
 
-### TitleCaser with Smart Quotes
-
-The example below demonstrates how to use the TitleCaser with smart quotes.
+### Real-World DOM Example
+Automatically normalize editorial headings in a publishing workflow:
 
+```html
+<h2>nodejs development on aws: an in-depth tutorial on server-side javascript deployment</h2>
+<h2>the iphone's impact on modern communication: a sociolinguistic analysis</h2>
+<h2>back-end and front-end</h2>
+```
 ```javascript
-import { TitleCaser } from '@danielhaim/titlecaser';
-
-// Instantiate a new TitleCaser object with AP style formatting and smart quotes enabled
-const titleCaser = new TitleCaser({ 
-  style: 'ap',
-  smartQuotes: true
-});
-
-// Set the input string to be tested
-const input = '"Never underestimate the power O\' persistence,"';
+function applyTitleCaseToH2Elements(options = { style: "apa" }) {
+  const h2Elements = document.querySelectorAll("h2");
 
-// Set the expected output
-const expectedOutput = '"Never Underestimate the Power O' Persistence,"';
+  h2Elements.forEach((h2) => {
+    h2.innerHTML = h2.innerHTML.toTitleCase(options);
+  });
+}
 
-// Call the toTitleCase method and store the result in actualOutput
-const actualOutput = titleCaser.toTitleCase(input);
+applyTitleCaseToH2Elements();
 ```
 
-## Architecture
-
-TitleCaser is structured into three main components:
-
-1. **TitleCaser.js** - The main class that provides the public API
-2. **TitleCaserConsts.js** - Contains constants, configuration, and data structures
-3. **TitleCaserUtils.js** - Contains utility functions for text processing
-
-### Data Structure
-
-The package uses several JSON files to store specialized terms:
-
-- **brandList.json**: Brand names and trademarks
-- **businessFinanceLegalTerms.json**: Business and legal terminology
-- **eCommerceDigitalTerms.json**: E-commerce and digital terms
-- **globalGeography.json**: Geographic terms
-- **marketingMediaTerms.json**: Marketing and media terms
-- **miscSpecializedTerms.json**: Miscellaneous specialized terms
-- **techComputingConcepts.json**: Technology and computing terms
-- **timeAcademicTerms.json**: Time and academic terms
+---
 
 ## API Reference
-
 ### Constructor
-
 ```javascript
 new TitleCaser(options)
 ```
 
-#### Options
+### Options
 
-- `style` (string): Title case style ('ap', 'apa', 'chicago', 'nyt', 'wikipedia', 'british')
-- `smartQuotes` (boolean): Convert straight quotes to curly quotes
-- `ignoredWords` (array): Words to ignore in title casing
-- `acronyms` (array): Words to treat as acronyms
+| Option                 | Type        | Default | Description |
+|------------------------|------------|---------|-------------|
+| `style`                | string     | `'ap'`  | Editorial style: `'ap' \| 'apa' \| 'chicago' \| 'nyt' \| 'wikipedia' \| 'british'` |
+| `smartQuotes`          | boolean    | `false` | Converts straight quotes (`' "`) to typographic curly quotes |
+| `neverCapitalize`      | string[]   | `[]`    | Additional words that should remain lowercase (merged with style defaults) |
+| `wordReplacementsList` | object[]   | internal defaults | Array of `{ 'term': 'replacement' }` objects used for term normalization |
+| `debug`                | boolean    | `false` | Enables internal warning logs during processing |
+| `normalizeWhitespace`  | boolean    | `true`  | Collapses consecutive whitespace and trims leading/trailing whitespace. Set to `false` to preserve original spacing (editor-safe mode). |
 
 ### Methods
 
 #### toTitleCase(text)
-
-Converts text to title case according to the selected style.
-
 ```javascript
-const result = titleCaser.toTitleCase('hello world');
-```
-
-#### setReplaceTerms(replaceTerms)
-
-Sets the word replacement list.
-
-```javascript
-titleCaser.setReplaceTerms([
-  { 'js': 'JavaScript' },
-  { 'api': 'API' }
-]);
+titleCaser.toTitleCase('hello world'); // → "Hello World"
 ```
 
 #### addReplaceTerm(term, replacement)
-
-Adds a single term replacement.
-
 ```javascript
 titleCaser.addReplaceTerm('js', 'JavaScript');
 ```
 
 #### removeReplaceTerm(term)
-
-Removes a term from the replacement list.
-
 ```javascript
 titleCaser.removeReplaceTerm('js');
 ```
 
-#### addExactPhraseReplacements(phrases)
-
-Adds exact phrase replacements.
+#### setReplaceTerms(terms)
+```javascript
+titleCaser.setReplaceTerms([
+  { 'js': 'JavaScript' },
+  { 'aws': 'AWS' }
+]);
+```
 
+#### addExactPhraseReplacements(phrases)
 ```javascript
 titleCaser.addExactPhraseReplacements([
-  { 'the correct phrase': 'The Correct Phrase' }
+  { 'the correct phrase': 'The Correct Phrase' },
+  { 'another phrase': 'Another Phrase' }
 ]);
 ```
 
 #### setStyle(style)
-
-Sets the title case style.
-
 ```javascript
 titleCaser.setStyle('chicago');
 ```
 
-## Build Process
+---
+
+## Test Coverage
 
 ```bash
-npm run build-package
-npm run build-docs
-npm run copy-package-to-docs
 npm run test
 ```
 
-## Test
+- Extensive unit test coverage
+- Cross-style validation (AP, Chicago, APA, NYT, Wikipedia)
+- Acronym disambiguation edge cases
+- Hyphenation edge cases
+- Brand normalization
 
-```bash
-npm run test
-```
+---
 
 ## Resources
 
@@ -435,123 +305,35 @@ Useful materials for improving your knowledge of writing and language style guid
 
 - [AP Stylebook, 56th Edition](https://store.stylebooks.com/ap-stylebook-56th-edition-print.html)
 - [Publication Manual of the American Psychological Association, Seventh Edition (2020)](https://apastyle.apa.org/products/publication-manual-7th-edition)
-- [Chicago Manual of Style: Capitalization](https://chat.openai.com/chat/643828ec-d4b5-4f21-b035-62946dd2cec3#:~:text=Chicago%20Manual%20of%20Style%3A%20Capitalization)
+- [Chicago Manual of Style: Capitalization](https://www.chicagomanualofstyle.org/book/ed17/part2/ch08/psec022.html)
 - [The Bluebook: A Uniform System of Citation. 21st ed. Cambridge: Harvard Law Review Association, 2020](https://open.mitchellhamline.edu/cgi/viewcontent.cgi?article=2782&context=wmlr)
 - [The Chicago Manual of Style, 17th Edition](https://press.uchicago.edu/ucp/books/book/chicago/C/bo25956703.html)
 - [The New York Times Manual of Style and Usage](https://www.worldcat.org/title/946964415)
-- [Wikipedia: Letter case](https://chat.openai.com/chat/643828ec-d4b5-4f21-b035-62946dd2cec3#:~:text=Wikipedia%3A%20Letter%20case)
+- [Wikipedia: Letter case](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Capital_letters)
 - [Wikipedia:Manual of Style/Titles of works](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Titles_of_works#Capital_letters)
 
+---
+
 ## Report Bugs
 
 If you encounter any bugs or issues while using the library or the demo page, please report them by opening a new issue in the repository's issue tracker. 
 
 When reporting a bug, please provide as much detail as possible, including the steps to reproduce the issue and any error messages that you see. I appreciate any contribution to improving this library.
 
+---
+
 ## Contributing
 
 We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
 
+---
+
 ## License
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
 
+---
+
 ## Changelog
 
 See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.
-
-## Tests
-
-```bash  
-TitleCaser – Combined Words Ending with Symbol
-  ✓ should preserve punctuation in "Championing Self-Acceptance: Landmark Initiative" (4 ms)
-TitleCaser – Disambiguation of Acronym vs. Pronoun (AP Style)
-  ✓ should capitalize "US" when preceded by "the" (1 ms)
-  ✓ should capitalize "US" in geopolitical context (with comma) (1 ms)
-  ✓ should capitalize "US" and "UK" together
-  ✓ should capitalize "US" after "from the" (1 ms)
-  ✓ should capitalize "US" after "via" (1 ms)
-  ✓ should capitalize "US" before "Military"
-  ✓ should capitalize "US" in geopolitical context (repeated case) (1 ms)
-  ✓ should capitalize pronoun "us" (case #1) (1 ms)
-  ✓ should capitalize pronoun "us" (case #2)
-  ✓ should capitalize pronoun "us" (case #3) (1 ms)
-  ✓ should capitalize "UK" in geopolitical context (with comma)
-  ✓ should handle multiple country codes in same sentence (1 ms)
-  ✓ should capitalize pronoun "us" in a parenthetical phrase (1 ms)
-  ✓ should capitalize "USA" in formal context
-  ✓ should capitalize "US" before "government" (AP style) (1 ms)
-  ✓ should capitalize "US" before "military" (AP style)
-  ✓ should capitalize "US" in geopolitical context (policy mention)
-  ✓ should capitalize "US" before "Military" (repeat case) (1 ms)
-  ✓ should capitalize "US" at the end of a sentence
-  ✓ should capitalize pronoun "us" in casual speech
-  ✓ should capitalize pronoun "us" in emotional context (1 ms)
-  ✓ should capitalize pronoun "us" in passive voice
-  ✓ should capitalize pronoun "us" with a compound verb
-  ✓ should capitalize pronoun "us" in an inverted clause (1 ms)
-  ✓ should capitalize pronoun "us" (repeat case #1)
-  ✓ should capitalize pronoun "us" (repeat case #2) (1 ms)
-  ✓ should capitalize pronoun "us" before "US Military"
-  ✓ should capitalize pronoun "us" before "military" (1 ms)
-  ✓ should capitalize pronoun "us" in a comma-separated clause
-  ✓ should capitalize "UK" at end of sentence (1 ms)
-  ✓ should capitalize "UK" in geopolitical context (repeat with comma)
-  ✓ should capitalize "UK" before government mention (1 ms)
-  ✓ should capitalize "UK" before territory mention
-  ✓ should handle multiple country codes and pronouns in one sentence (2 ms)
-  ✓ should handle multiple codes and pronouns with mention of military
-  ✓ should handle multiple codes and pronouns with mention of talks (1 ms)
-  ✓ should handle multiple codes and pronouns with mention of a bill (1 ms)
-  ✓ should capitalize "USA" in formal context (repeat case)
-  ✓ should capitalize "USA" before a bill mention (1 ms)
-  ✓ should handle AP-style acronym "U.S." in uppercase context
-  ✓ should handle "On & Off" phrases #1 (1 ms)
-  ✓ should handle "On & Off" phrases #2
-TitleCaser – Hyphenated & Apostrophized Words
-  ✓ should capitalize both parts of "t-mobile"
-  ✓ should capitalize "coca-cola"
-  ✓ should capitalize general hyphenated term "e-commerce" (1 ms)
-  ✓ should capitalize apostrophe word "o'connor"
-TitleCaser – Basic Title Casing Options (Default Style)
-  ✓ should convert a basic lowercase phrase to title case
-  ✓ should handle excessive spacing and lowercase articles
-  ✓ should handle brand casing with AP-style logic (1 ms)
-  ✓ should preserve correct casing in hyphenated names like "louis-iv"
-  ✓ should properly capitalize prepositions beyond 3 letters (1 ms)
-TitleCaser – Class Methods (setReplaceTerms, addExactPhraseReplacements, etc.)
-  ✓ should apply Wikipedia style to an entire sentence (1 ms)
-  ✓ should apply multiple term replacements via setReplaceTerms()
-  ✓ should apply exact phrase replacements (1 ms)
-  ✓ should remove a single replacement rule via removeReplaceTerm()
-TitleCaser – Variation Stability Tests (AP, Chicago, APA, NYT, Wikipedia)
-  ✓ should correctly handle brand names with "ap" style
-  ✓ should handle brand name "NERDs Candy" with AP style
-  ✓ should handle possessives and colons (AP style)
-  ✓ should handle hyphenated "BACK-end" with AP style
-  ✓ should handle acronym with colon (AP style) (1 ms)
-  ✓ should handle colon + comparison phrase (Chicago)
-  ✓ should capitalize hyphenated terms (Chicago) (1 ms)
-  ✓ should apply custom replacements for brand names (Chicago) (1 ms)
-  ✓ Smart quotes enabled
-  ✓ should keep acronyms in uppercase (Chicago)
-  ✓ should capitalize after colon (APA) (1 ms)
-  ✓ should handle colon and apostrophes (APA)
-  ✓ should handle short conjunctions and brand normalization (APA) (1 ms)
-  ✓ should handle acronym + colon usage (NYT) (1 ms)
-  ✓ should preserve sentence case for Wikipedia style (DevOps example) (1 ms)
-  ✓ should handle Wikipedia style with colon usage (1 ms)
-TitleCaser – Reserved Words & Special Handling
-  ✓ should transform a single reserved word correctly
-  ✓ should transform sentence with reserved word + colon
-  ✓ should handle possessive form of reserved word
-  ✓ should apply brand replacements (e.g., "mcdonalds" → "McDonald's") (1 ms)
-  ✓ should handle HTML <br> with colon (spaced)
-  ✓ should handle HTML <br> with full sentence split (1 ms)
-  ✓ should handle <br> with no space after colon
-  ✓ should handle ampersand "&" symbol (1 ms)
-  ✓ should handle excessive whitespace
-TitleCaser – addReplaceTerm Method
-  ✓ should add a new replacement term
-  ✓ should update an existing replacement term
-```