summit-marker 3.0.1 → 3.0.2

package/README.md

@@ -7,106 +7,112 @@
 
 ![Marker Demo](https://cdn.phototourl.com/free/2026-07-26-2b052282-6e2b-469d-8358-9c12ddf38764.jpg)
 
-# Marker
-
 A zero-dependency terminal styling and CLI presentation toolkit for Node.js.
 
-Marker provides everything needed to create beautiful terminal applications:
+Marker gives developers everything needed to create beautiful terminal applications without installing multiple packages.
+
+Built by **Summit**.
+
+---
+
+# Features
 
-- Colors
-- Styles
-- RGB
-- Hex colors
+- Terminal colors
+- Text styles
+- RGB colors
+- Full HEX colors
 - True RGB gradients
 - Gradient presets
 - Themes
-- Box formatting
-- Messages
+- Terminal boxes
+- Styled messages
 - Symbols
 - Text utilities
-- Progress formatting
+- Progress bars
+- Spinners
+- Tables
+- Logger system
 - Terminal detection
-
-Built by **Summit**.
+- Developer utilities
 
 ---
 
 # Why Marker?
 
-Terminal applications often need more than simple colors.
+Most terminal applications need multiple libraries for:
 
-Developers usually combine multiple libraries for:
-
-- terminal colors
-- message formatting
-- boxes
+- colors
+- formatting
 - symbols
-- progress displays
-- gradients
+- loading states
+- tables
+- logging
+- CLI presentation
 
 Marker combines these features into one lightweight package.
 
-Instead of writing:
+Instead of:
 
 ```js
 "\x1b[31mError\x1b[0m"
-```
 
 You can write:
 
-```js
 marker.red("Error");
-```
 
-Or:
+or:
 
-```js
 marker.error("Build failed");
-```
 
 Marker focuses on:
 
-- simple APIs
-- zero dependencies
-- cross-platform support
-- beautiful CLI output
+simple APIs
+
+zero dependencies
+
+cross-platform support
+
+fast installation
+
+beautiful CLI output
 
----
 
-# Marker vs Chalk
-
-| Feature | Marker | Chalk |
-|---|---|---|
-| Colors | ✅ | ✅ |
-| Styles | ✅ | ✅ |
-| RGB | ✅ | ✅ |
-| Hex colors | ✅ | ❌ |
-| True RGB gradients | ✅ | ❌ |
-| Gradient presets | ✅ | ❌ |
-| Themes | ✅ | ❌ |
-| Box formatting | ✅ | ❌ |
-| Built-in messages | ✅ | ❌ |
-| Symbols API | ✅ | ❌ |
-| Text utilities | ✅ | ❌ |
-| Zero dependencies | ✅ | Depends on version |
-
-Marker is designed as a complete terminal presentation toolkit.
 
 ---
 
-# Installation
+Marker vs Chalk
+
+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
+
+
 
-Install Marker using npm:
+---
+
+Installation
 
-```bash
 npm install summit-marker
-```
+
 
 ---
 
-# Quick Start
+Quick Start
 
-```js
 import marker from "summit-marker";
 
 console.log(
@@ -120,25 +126,18 @@ console.log(
 console.log(
   marker.success("Installed")
 );
-```
 
 Output:
 
-```
 Success
 Hello Marker
 ✔ Installed
-```
 
----
-
-# API Documentation
 
-# Colors
+---
 
-Marker supports terminal colors:
+Colors
 
-```js
 marker.red("Red");
 
 marker.green("Green");
@@ -149,235 +148,103 @@ marker.orange("Orange");
 
 marker.pink("Pink");
 
-marker.brown("Brown");
-
 marker.neon("Neon");
-```
-
-Additional colors:
-
-```js
-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");
-```
 
 ---
 
-# Styles
+Styles
 
-Marker includes text styles:
-
-```js
 marker.bold("Bold");
 
 marker.italic("Italic");
 
 marker.underline("Underline");
-```
 
-Styles can be combined:
+Combine styles:
 
-```js
-marker.bold.red("Critical Error");
-
-marker.underline.blue("Documentation");
-```
-
----
-
-# Chaining
-
-Marker uses a chainable API:
-
-```js
-marker
-  .bold
-  .green
-  ("Success");
-```
-
-Example:
-
-```js
-marker.bold.red.underline(
-  "Important"
+marker.bold.red(
+  "Critical Error"
 );
-```
+
 
 ---
 
-# RGB Colors
+RGB
 
-Marker supports true 24-bit RGB colors.
+Marker supports true 24-bit RGB.
 
 That means:
 
-```
 16,777,216 possible colors
-```
 
 Example:
 
-```js
 marker.rgb(
   255,
   120,
   0
-)("Custom Orange");
-```
-
----
-
-# Hex Colors
-
-Use any HEX color:
+)(
+  "Orange"
+);
 
-```js
-marker.hex("#ff8800")
-("Orange");
-```
 
-Examples:
+---
 
-```js
-marker.hex("#ff0000")
-("Red");
+HEX Colors
 
-marker.hex("#00ff00")
-("Green");
+marker.hex(
+  "#ff8800"
+)(
+  "Orange"
+);
 
-marker.hex("#0000ff")
-("Blue");
-```
 
 ---
 
-# Gradients
+Gradients
 
-Marker supports multiple gradient systems.
+Basic gradient:
 
-## Basic Gradient
-
-```js
 marker.gradient(
   "SUMMIT"
 );
-```
 
----
+True RGB gradient:
 
-# True RGB Gradients
-
-Marker supports full RGB gradients:
-
-```js
 marker.rgbGradient(
   "SUMMIT"
 );
-```
-
-Unlike limited terminal palettes, RGB gradients use true color output.
-
----
-
-# Gradient Presets
 
-Marker includes built-in gradients:
+Gradient presets:
 
-## Rainbow
-
-```js
 marker.gradients.rainbow(
-  "RAINBOW"
+  "Rainbow"
 );
-```
-
-## Sunset
 
-```js
 marker.gradients.sunset(
-  "SUNSET"
+  "Sunset"
 );
-```
-
-## Ocean
 
-```js
 marker.gradients.ocean(
-  "OCEAN"
+  "Ocean"
 );
-```
 
-## Fire
-
-```js
 marker.gradients.fire(
-  "FIRE"
+  "Fire"
 );
-```
 
-## Neon
-
-```js
 marker.gradients.neon(
-  "NEON"
-);
-```
-
-## Candy
-
-```js
-marker.gradients.candy(
-  "CANDY"
+  "Neon"
 );
-```
-
-## Forest
 
-```js
-marker.gradients.forest(
-  "FOREST"
-);
-```
-
-## Ice
-
-```js
-marker.gradients.ice(
-  "ICE"
-);
-```
-
-## Space
-
-```js
-marker.gradients.space(
-  "SPACE"
-);
-```
 
 ---
 
-# Themes
-
-Marker supports themes for consistent application styling.
+Themes
 
-Example:
+Create reusable terminal styles.
 
-```js
 const theme =
   marker.themes.default;
 
@@ -388,290 +255,268 @@ theme.primary(
 theme.success(
   "Success"
 );
-```
 
-Themes allow applications to define reusable styles.
 
 ---
 
-# Box Formatting
+Boxes
 
 Create terminal boxes:
 
-```js
 marker.box(
   "Hello Marker"
 );
-```
 
 Example:
 
-```
 ┌──────────────┐
 │ Hello Marker │
 └──────────────┘
-```
 
----
 
-# Messages
+---
 
-Marker includes styled terminal messages.
+Messages
 
-## Success
+Success
 
-```js
 marker.success(
-  "Installed"
+  "Build complete"
 );
-```
 
 Output:
 
-```
-✔ Installed
-```
-
----
+✔ Build complete
 
-## Error
+Error
 
-```js
 marker.error(
-  "Failed"
+  "Build failed"
 );
-```
 
 Output:
 
-```
-✖ Failed
-```
-
----
+✖ Build failed
 
-## Warning
+Warning
 
-```js
 marker.warning(
   "Deprecated"
 );
-```
 
 Output:
 
-```
 ⚠ Deprecated
-```
-
----
 
-## Info
+Info
 
-```js
 marker.info(
   "Searching"
 );
-```
 
 Output:
 
-```
 ℹ Searching
-```
 
----
 
-# Symbols
+---
 
-Marker provides terminal-safe symbols.
+Symbols
 
-```js
-marker.symbols.success
-```
+marker.symbols.success;
 
-Returns:
+marker.symbols.error;
 
-```
-✔
-```
+marker.symbols.loading;
 
 Available symbols:
 
-```js
-marker.symbols.check
+check
+cross
+star
+arrowRight
+loading
+block
 
-marker.symbols.cross
 
-marker.symbols.star
+---
 
-marker.symbols.arrowRight
+Text Utilities
 
-marker.symbols.loading
+CAPS:
 
-marker.symbols.block
-```
+marker.caps(
+  "hello marker"
+);
 
-Symbols are designed for:
+Lowercase:
 
-- CLI interfaces
-- progress bars
-- spinners
-- terminal tools
+marker.lower(
+  "HELLO"
+);
 
----
+Title case:
+
+marker.title(
+  "hello marker"
+);
 
-# Text Utilities
 
-Marker includes text transformations.
+---
 
-## CAPS
+Progress
 
-```js
-marker.caps(
-  "hello marker"
-);
-```
+Marker supports terminal progress displays.
 
-Output:
+Example:
+
+████████░░ 80%
 
-```
-HELLO MARKER
-```
 
 ---
 
-## Lowercase
+Spinners
 
-```js
-marker.lower(
-  "HELLO"
-);
-```
+Marker includes npm-style loading spinners.
 
-Output:
+Example:
 
-```
-hello
-```
+const spinner =
+  marker.spinner(
+    "Installing"
+  );
 
----
+spinner.start();
 
-## Title Case
+setTimeout(() => {
+  spinner.success(
+    "Installed"
+  );
+}, 2000);
 
-```js
-marker.title(
-  "hello marker"
-);
-```
+Useful for:
+
+installers
+
+build tools
+
+package managers
+
+CLI applications
 
-Output:
 
-```
-Hello Marker
-```
 
 ---
 
-# Progress Formatting
+Tables
 
-Marker supports terminal-safe progress displays.
+Create terminal tables:
 
-Example:
+marker.table([
+  [
+    "Package",
+    "Status"
+  ],
+  [
+    "Marker",
+    "Ready"
+  ]
+]);
 
-```
-████████░░ 80%
-```
+Useful for:
+
+dashboards
+
+reports
+
+developer tools
 
-Characters:
 
-```
-█ Filled
-░ Empty
-```
 
 ---
 
-# Color Detection
+Logger
 
-Marker automatically detects terminal support.
+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
 
-```js
 marker.level;
 
 marker.supportsColor;
-```
 
 Levels:
 
-```
 0 - Disabled
 1 - Basic colors
 2 - 256 colors
 3 - True RGB
-```
+
 
 ---
 
-# Environment Variables
+Environment Variables
 
 Disable colors:
 
-```bash
 NO_COLOR=1 node app.js
-```
 
 Force colors:
 
-```bash
 FORCE_COLOR=3 node app.js
-```
 
----
-
-# TypeScript
-
-Marker includes TypeScript support.
 
-```ts
-import marker from "summit-marker";
+---
 
-marker.bold.blue(
-  "Hello TypeScript"
-);
+Zero Dependencies
 
-marker.rgb(
-  255,
-  0,
-  0
-)(
-  "Red"
-);
-```
+Marker uses:
 
----
+Dependencies: 0
 
-# Examples
+Benefits:
 
-Examples are included:
+smaller installs
 
-```bash
-node examples/BestColors.js
+fewer security risks
 
-node examples/symbols.js
+faster setup
 
-node examples/gradients.js
+fewer dependency conflicts
 
-node examples/themes.js
 
-node examples/progress.js
-```
 
 ---
 
-# Project Structure
+Project Structure
 
-```
 summit-marker/
 │
 ├── src/
@@ -680,93 +525,71 @@ summit-marker/
 │   ├── styles.js
 │   ├── messages.js
 │   ├── gradients.js
-│   ├── rgbGradient.js
 │   ├── themes.js
 │   ├── box.js
-│   └── text.js
+│   ├── text.js
+│   ├── spinner.js
+│   ├── table.js
+│   └── logger.js
 │
 ├── examples/
-│   ├── BestColors.js
-│   ├── symbols.js
-│   ├── gradients.js
-│   ├── themes.js
-│   └── progress.js
-│
 ├── README.md
+├── EULA.md
 └── package.json
-```
+
 
 ---
 
-# Performance
+Changelog
 
-Marker is built to be lightweight.
+3.0.2
 
-## Zero Dependencies
+Added:
 
-Marker uses:
+Spinner system
 
-```
-Dependencies: 0
-```
+Terminal tables
 
-Benefits:
+Logger utilities
 
-- smaller installs
-- fewer security risks
-- faster setup
-- fewer dependency conflicts
+Developer utilities
 
----
+Improved CLI output
 
-# Roadmap
 
-Future Marker versions may include:
+3.0.0
 
-- More themes
-- More terminal helpers
-- Advanced progress systems
-- More formatting utilities
-- API improvements
-- Additional CLI features
+Added:
 
----
+Theme system
 
-# Changelog
+Gradient presets
 
-## 3.0.0
+True RGB gradients
 
-Added:
+Box formatting
 
-- Theme system
-- Gradient presets
-- True RGB gradients
-- Box formatting
-- Text utilities
-- Expanded symbols
-- Improved CLI presentation
+Text utilities
 
-## 1.0.0
+Expanded symbols
 
-Initial release:
 
-- Colors
-- Styles
-- RGB
-- Hex
-- Gradients
-- Messages
 
 ---
 
-# License
+License
+
+Marker is licensed under the Summit EULA.
+
+See:
+
+EULA.md
 
-UNLICENSED
 
 ---
 
-# Built By Summit
+Built By Summit
 
-Marker is developed and maintained by **Summit**.
+Marker is developed and maintained by Summit.
 
 Creating lightweight developer tools with simple, powerful APIs.