summit-marker 2.0.0 → 3.0.2

package/README.md

@@ -5,376 +5,591 @@
 ![license](https://img.shields.io/npm/l/summit-marker)
 ![dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)
 
-![Marker Colors Demo](https://cdn.phototourl.com/free/2026-07-26-2b052282-6e2b-469d-8358-9c12ddf38764.jpg)
+![Marker Demo](https://cdn.phototourl.com/free/2026-07-26-2b052282-6e2b-469d-8358-9c12ddf38764.jpg)
 
-Marker Supports **16.7 Million True Colors** With RGB and Hex Support
+A zero-dependency terminal styling and CLI presentation toolkit for Node.js.
 
-A zero-dependency Chalk alternative for Node.js with terminal colors, chaining, RGB, hex colors, gradients, and styled messages.
+Marker gives developers everything needed to create beautiful terminal applications without installing multiple packages.
 
 Built by **Summit**.
 
 ---
 
-## Quick Start
+# Features
+
+- Terminal colors
+- Text styles
+- RGB colors
+- Full HEX colors
+- True RGB gradients
+- Gradient presets
+- Themes
+- Terminal boxes
+- Styled messages
+- Symbols
+- Text utilities
+- Progress bars
+- Spinners
+- Tables
+- Logger system
+- Terminal detection
+- Developer utilities
 
-```js
-import marker from "summit-marker";
+---
 
-console.log(marker.bold.green("✓ Marker is working"));
+# Why Marker?
 
-console.log(marker.gradient("SUMMIT"));
-```
+Most terminal applications need multiple libraries for:
 
----
+- colors
+- formatting
+- symbols
+- loading states
+- tables
+- logging
+- CLI presentation
 
-## Package Stats
+Marker combines these features into one lightweight package.
 
-- Dependencies: 0
-- Runtime: Node.js
-- Color support: True RGB
-- Color range: 16,777,216 colors
+Instead of:
 
-## Supported
+```js
+"\x1b[31mError\x1b[0m"
 
-- Node.js ✅
-- Linux terminals ✅
-- macOS terminals ✅
-- Windows terminals ✅
-- Termux/Android Node.js ✅
+You can write:
 
-## Changelog
+marker.red("Error");
 
-### 1.0.0
+or:
 
-- Initial release
-- Added colors
-- Added styles
-- Added RGB/hex support
-- Added gradients
-- Added message helpers
+marker.error("Build failed");
 
----
+Marker focuses on:
 
-## Marker vs Traditional ANSI
+simple APIs
 
-| Feature | Marker |
-|---|---|
-| Colors | ✅ |
-| RGB | ✅ |
-| Hex | ✅ |
-| Gradients | ✅ |
-| Chaining | ✅ |
-| Zero dependencies | ✅ |
-| Manual ANSI codes | ❌ |
+zero dependencies
 
----
+cross-platform support
 
-## Why Marker?
+fast installation
 
-Writing terminal colors manually with ANSI escape codes is difficult and hard to read.
+beautiful CLI output
 
-Instead of:
 
-```js
-"\x1b[31mError\x1b[0m"
-```
 
-Marker lets developers write:
+---
 
-```js
-marker.red("Error")
-```
+Marker vs Chalk
 
-Marker provides a clean and modern API for creating beautiful command-line output.
+Feature	Marker	Chalk
 
----
+Colors	✅	✅
+Styles	✅	✅
+RGB	✅	✅
+HEX colors	✅	❌
+True RGB gradients	✅	❌
+Gradient presets	✅	❌
+Themes	✅	❌
+Boxes	✅	❌
+Messages	✅	❌
+Symbols	✅	❌
+Text utilities	✅	❌
+Spinners	✅	❌
+Tables	✅	❌
+Logger	✅	❌
+Dependencies	0	Depends
 
-## Features
-
-- 🎨 Basic terminal colors
-- 🌈 Extended color palette
-- 🔗 Chainable styles
-- ✨ Bold, italic, underline, and more
-- 🎯 RGB true-color support
-- 🔢 Hex color support
-- 🌈 Gradient text
-- ✅ Success, error, warning, and info messages
-- 🖥️ Automatic color detection
-- 📦 Zero dependencies
-- ⚡ Lightweight and fast
-- 🟦 TypeScript support
 
----
 
-## Installation
+---
 
-Install Marker with npm:
+Installation
 
-```bash
 npm install summit-marker
-```
+
 
 ---
 
-## Basic Usage
+Quick Start
 
-```js
 import marker from "summit-marker";
 
-console.log(marker.red("Error"));
-console.log(marker.green("Success"));
-console.log(marker.blue("Information"));
-```
+console.log(
+  marker.green("Success")
+);
 
----
+console.log(
+  marker.bold.blue("Hello Marker")
+);
 
-## TypeScript
+console.log(
+  marker.success("Installed")
+);
 
-Marker includes TypeScript declarations.
+Output:
 
-```ts
-import marker from "summit-marker";
-
-marker.bold.blue("Hello TypeScript");
+Success
+Hello Marker
+✔ Installed
 
-marker.rgb(255, 0, 0)("Red");
-```
 
 ---
 
-## Colors
-
-Marker includes many built-in colors:
+Colors
 
-```js
 marker.red("Red");
+
 marker.green("Green");
+
 marker.blue("Blue");
+
 marker.orange("Orange");
+
 marker.pink("Pink");
-marker.brown("Brown");
+
 marker.neon("Neon");
 
-marker.gold("Gold");
-marker.lime("Lime");
-marker.teal("Teal");
-marker.violet("Violet");
-marker.magenta("Magenta");
-marker.navy("Navy");
-marker.skyBlue("Sky Blue");
-marker.emerald("Emerald");
-```
 
 ---
 
-## Text Styles
+Styles
 
-```js
 marker.bold("Bold");
 
 marker.italic("Italic");
 
 marker.underline("Underline");
-```
+
+Combine styles:
+
+marker.bold.red(
+  "Critical Error"
+);
+
 
 ---
 
-## Chaining
+RGB
 
-Combine colors and styles:
+Marker supports true 24-bit RGB.
 
-```js
-marker.bold.red("Critical Error");
+That means:
 
-marker.underline.blue("Documentation");
+16,777,216 possible colors
 
-marker.neon.emerald("Success");
-```
+Example:
 
----
+marker.rgb(
+  255,
+  120,
+  0
+)(
+  "Orange"
+);
 
-## RGB Colors
 
-Marker supports true 24-bit RGB colors.
+---
 
-```js
-marker.rgb(255, 120, 0)("Custom Orange");
-```
+HEX Colors
 
-RGB supports:
+marker.hex(
+  "#ff8800"
+)(
+  "Orange"
+);
 
-```
-16,777,216 possible colors
-```
 
 ---
 
-## Hex Colors
+Gradients
 
-Use any hex color:
+Basic gradient:
 
-```js
-marker.hex("#ff8800")("Custom Orange");
-```
+marker.gradient(
+  "SUMMIT"
+);
 
-Examples:
+True RGB gradient:
 
-```js
-marker.hex("#ff0000")("Red");
+marker.rgbGradient(
+  "SUMMIT"
+);
+
+Gradient presets:
+
+marker.gradients.rainbow(
+  "Rainbow"
+);
+
+marker.gradients.sunset(
+  "Sunset"
+);
+
+marker.gradients.ocean(
+  "Ocean"
+);
 
-marker.hex("#00ff00")("Green");
+marker.gradients.fire(
+  "Fire"
+);
+
+marker.gradients.neon(
+  "Neon"
+);
 
-marker.hex("#0000ff")("Blue");
-```
 
 ---
 
-## Gradients
+Themes
 
-Create colorful gradient text:
+Create reusable terminal styles.
+
+const theme =
+  marker.themes.default;
+
+theme.primary(
+  "Primary"
+);
+
+theme.success(
+  "Success"
+);
 
-```js
-marker.gradient("SUMMIT");
-```
 
 ---
 
-## Messages
+Boxes
 
-Marker includes common terminal messages:
+Create terminal boxes:
 
-```js
-marker.success("Package installed");
+marker.box(
+  "Hello Marker"
+);
 
-marker.error("Build failed");
+Example:
+
+┌──────────────┐
+│ Hello Marker │
+└──────────────┘
+
+
+---
+
+Messages
+
+Success
+
+marker.success(
+  "Build complete"
+);
 
-marker.warning("Deprecated feature");
+Output:
 
-marker.info("Searching...");
-```
+✔ Build complete
 
-Example output:
+Error
+
+marker.error(
+  "Build failed"
+);
+
+Output:
 
-```
-✔ Package installed
 ✖ Build failed
-⚠ Deprecated feature
-ℹ Searching...
-```
+
+Warning
+
+marker.warning(
+  "Deprecated"
+);
+
+Output:
+
+⚠ Deprecated
+
+Info
+
+marker.info(
+  "Searching"
+);
+
+Output:
+
+ℹ Searching
+
 
 ---
 
-## Color Detection
+Symbols
 
-Marker automatically detects terminal color support.
+marker.symbols.success;
 
-```js
-console.log(marker.level);
+marker.symbols.error;
+
+marker.symbols.loading;
+
+Available symbols:
+
+check
+cross
+star
+arrowRight
+loading
+block
+
+
+---
+
+Text Utilities
+
+CAPS:
 
-console.log(marker.supportsColor);
-```
+marker.caps(
+  "hello marker"
+);
+
+Lowercase:
+
+marker.lower(
+  "HELLO"
+);
+
+Title case:
+
+marker.title(
+  "hello marker"
+);
+
+
+---
+
+Progress
+
+Marker supports terminal progress displays.
+
+Example:
+
+████████░░ 80%
+
+
+---
+
+Spinners
+
+Marker includes npm-style loading spinners.
+
+Example:
+
+const spinner =
+  marker.spinner(
+    "Installing"
+  );
+
+spinner.start();
+
+setTimeout(() => {
+  spinner.success(
+    "Installed"
+  );
+}, 2000);
+
+Useful for:
+
+installers
+
+build tools
+
+package managers
+
+CLI applications
+
+
+
+---
+
+Tables
+
+Create terminal tables:
+
+marker.table([
+  [
+    "Package",
+    "Status"
+  ],
+  [
+    "Marker",
+    "Ready"
+  ]
+]);
+
+Useful for:
+
+dashboards
+
+reports
+
+developer tools
+
+
+
+---
+
+Logger
+
+Marker includes a developer-focused logger.
+
+marker.logger.info(
+  "Starting server"
+);
+
+marker.logger.success(
+  "Connected"
+);
+
+marker.logger.warning(
+  "Using fallback"
+);
+
+marker.logger.error(
+  "Failed"
+);
+
+Logger levels:
+
+info
+success
+warning
+error
+debug
+
+
+---
+
+Terminal Detection
+
+marker.level;
+
+marker.supportsColor;
 
 Levels:
 
-```
 0 - Disabled
 1 - Basic colors
 2 - 256 colors
-3 - True RGB colors
-```
+3 - True RGB
+
+
+---
+
+Environment Variables
 
 Disable colors:
 
-```bash
 NO_COLOR=1 node app.js
-```
 
-Force color support:
+Force colors:
 
-```bash
 FORCE_COLOR=3 node app.js
-```
+
 
 ---
 
-## Example
+Zero Dependencies
 
-Run:
+Marker uses:
 
-```bash
-node examples/BestColors.js
-```
+Dependencies: 0
 
-Example:
+Benefits:
 
-```
-=== Basic Colors ===
-Red
-Green
-Blue
-Orange
-Pink
-Brown
-Neon
+smaller installs
 
-=== Styles ===
-Bold
-Italic
-Underline
+fewer security risks
 
-=== Chaining ===
-Bold Red
-Blue Underline
+faster setup
 
-=== RGB ===
-Custom RGB Orange
+fewer dependency conflicts
 
-=== HEX ===
-Custom Hex Purple
 
-=== Gradient ===
-SUMMIT
-```
 
 ---
 
-## Project Structure
+Project Structure
 
-```
 summit-marker/
+│
 ├── src/
 │   ├── index.js
 │   ├── colors.js
 │   ├── styles.js
 │   ├── messages.js
-│   └── types.d.ts
+│   ├── gradients.js
+│   ├── themes.js
+│   ├── box.js
+│   ├── text.js
+│   ├── spinner.js
+│   ├── table.js
+│   └── logger.js
+│
 ├── examples/
-│   └── BestColors.js
 ├── README.md
+├── EULA.md
 └── package.json
-```
+
 
 ---
 
-## Technology
+Changelog
+
+3.0.2
+
+Added:
+
+Spinner system
+
+Terminal tables
+
+Logger utilities
+
+Developer utilities
+
+Improved CLI output
+
+
+3.0.0
 
-Marker is built with:
+Added:
+
+Theme system
+
+Gradient presets
+
+True RGB gradients
+
+Box formatting
+
+Text utilities
+
+Expanded symbols
 
-- Node.js
-- JavaScript ES Modules
-- ANSI terminal formatting
-- TypeScript declarations
 
-No external dependencies are required.
 
 ---
 
-## License
+License
+
+Marker is licensed under the Summit EULA.
+
+See:
+
+EULA.md
 
-UNLICENSED
 
 ---
 
-## Built By
+Built By Summit
+
+Marker is developed and maintained by Summit.
 
-**Summit**
+Creating lightweight developer tools with simple, powerful APIs.