termchart 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5399b740269dde9e659e037b6b54d158e71c4828778f6077686e59d0409a7e
-  data.tar.gz: a4bb881eac513473fd08d2a9314dd9bfd18954b5931c546ee35955473614d490
+  metadata.gz: 66ec55314930e7c2c54652b8acac00c757c5e707ce56d407150af1dc452b089f
+  data.tar.gz: 4a70285ba3b7bf50b39cce857a54dbb05e913c070777e66e1f5247ac9a6b310a
 SHA512:
-  metadata.gz: '08a3561dca9546457c27d6515ade0a83c59587dbc5dd2deb39617980e4b5e9c201e4ea5700d97267ed0e58f0f7e8c44829e3e1c95b8de504b8cd2aa5c3f0a155'
-  data.tar.gz: 39bb6081e3eee076630fe3806e670fac5bb15440e542f29ca3be06632e043e06d7a806925318a76ee2cc05283b122866c7d0afb003c9e213785b33427cc1acd2
+  metadata.gz: 6f48f4f24d481cde7647774a34992231bfabf8ae1839ff01967db03e428abb0c0179782ca3f7341accc36500cf15850376e736a43040c54d0636844dbb28f12a
+  data.tar.gz: 3fd672278e764531694fa78abcb71d86756c3f159077a1ebab81a423ff0c74dcfb8d4ca8e76d033349913a4c457bb9fd3418400dc140d7b0b6d2d5babe8c777c

data/README.md

@@ -0,0 +1,178 @@
+# Termchart - Terminal Charts with Unicode and ANSI Colors
+
+![Ruby](https://img.shields.io/badge/language-Ruby-red) [![Gem Version](https://badge.fury.io/rb/termchart.svg)](https://badge.fury.io/rb/termchart) ![Unlicense](https://img.shields.io/badge/license-Unlicense-green) ![Stay Amazing](https://img.shields.io/badge/Stay-Amazing-important)
+
+<img src="img/logo.svg" align="left" width="150" alt="Termchart Logo">
+
+Render sparklines, line charts, candlestick charts, and bar charts directly in the terminal. Pure Ruby, zero dependencies.
+
+All chart types render to plain strings with ANSI color codes — composable with any TUI framework (rcurses, curses, or raw terminal output).
+
+<br clear="left"/>
+
+## Features
+
+- **Sparklines** — compact single-line charts using ▁▂▃▄▅▆▇█
+- **Line charts** — high-resolution braille dot plotting (2×4 dots per cell)
+- **Candlestick charts** — OHLC financial charts with green/red coloring
+- **Bar charts** — horizontal and vertical with sub-cell precision
+- **256-color and RGB** — supports integer color codes and hex strings
+- **No dependencies** — pure Ruby, no native extensions
+- **String output** — no direct terminal I/O, works anywhere
+
+## Installation
+
+```bash
+gem install termchart
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'termchart'
+```
+
+## Sparklines
+
+Map values to 8 eighth-block characters on a single line.
+
+```ruby
+require 'termchart'
+
+puts Termchart.spark([1, 3, 5, 2, 8, 4, 6])
+# => ▁▃▅▂█▄▆
+
+puts Termchart.spark([10, 20, 30, 25, 40], color: :green)
+# => ▁▃▅▄█  (in green)
+```
+
+Supported color names: `:red`, `:green`, `:blue`, `:yellow`, `:cyan`, `:magenta`, `:white`, `:gray`, `:orange`
+
+## Line Charts
+
+Braille-dot line charts with Y-axis labels. Each terminal cell provides 2×4 sub-pixel resolution via Unicode braille patterns (U+2800–U+28FF).
+
+```ruby
+chart = Termchart::Line.new(width: 60, height: 20)
+chart.add(prices, color: 82, label: "SPY")
+chart.add(gold,   color: 226, label: "GLD")
+puts chart.render
+```
+
+Output:
+```
+ 460┤⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠔⠊⠢⡀⠀⠀⠀⠀⠀⢀⡠⠊
+    │⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠔⠁⠀⠀⠀⠈⠢⡀⠀⢀⠔⠊
+    │⠀⠀⠀⠀⠀⠀⢀⡠⠤⠒⠢⡀⠀⠀⠀⣀⠔⠁⠀⠀⠀⠀⠀⠀⠀⠈⠔⠁
+ 440┤⠀⠀⠀⢀⡠⠊⠁⠀⠀⠀⠀⠈⠢⡠⠊⠁
+    │⠀⠀⣀⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁
+    │⠀⡰⠁
+ 420┤⡰⠁
+     ━━ SPY
+```
+
+## Candlestick Charts
+
+OHLC candlestick charts for financial data. Green for up candles, red for down.
+
+```ruby
+chart = Termchart::Candle.new(width: 60, height: 20)
+chart.add([
+  { o: 100, h: 105, l: 98,  c: 103 },
+  { o: 103, h: 107, l: 101, c: 99  },
+  { o: 99,  h: 104, l: 97,  c: 102 },
+  { o: 102, h: 108, l: 100, c: 106 },
+])
+puts chart.render
+```
+
+Uses `│` for wicks and `█` for bodies. Y-axis labels on the left at 5 price levels.
+
+## Bar Charts
+
+Horizontal and vertical bar charts with sub-cell precision using eighth-block characters.
+
+### Horizontal
+
+```ruby
+chart = Termchart::Bar.new(width: 40, orientation: :horizontal)
+chart.add("GLD", 185.50, color: 226)
+chart.add("SPY", 450.00, color: 82)
+chart.add("SLV", 22.30,  color: 245)
+puts chart.render
+```
+
+```
+GLD │███████████▏            185.50
+SPY │████████████████████████    450
+SLV │█▍                       22.30
+```
+
+### Vertical
+
+```ruby
+chart = Termchart::Bar.new(width: 30, height: 10, orientation: :vertical)
+chart.add("Q1", 80, color: 82)
+chart.add("Q2", 95, color: 82)
+chart.add("Q3", 70, color: 196)
+chart.add("Q4", 110, color: 82)
+puts chart.render
+```
+
+## Colors
+
+All chart types accept colors as:
+
+| Format | Example | Description |
+|--------|---------|-------------|
+| Integer | `82` | 256-color palette index |
+| Hex string | `"FF0000"` | RGB hex (with or without `#`) |
+| Symbol | `:green` | Named color (sparklines only) |
+
+## Canvas API
+
+For custom visualizations, use the canvas classes directly.
+
+### Canvas
+
+Character grid where each cell holds a character, foreground color, and background color.
+
+```ruby
+canvas = Termchart::Canvas.new(40, 10)
+canvas.set(5, 3, "█", fg: 196, bg: 233)
+puts canvas.render
+```
+
+### BrailleCanvas
+
+Each cell maps to a 2×4 braille dot grid for sub-cell resolution.
+
+```ruby
+canvas = Termchart::BrailleCanvas.new(40, 10)
+# Pixel space: 80×40
+canvas.set_dot(15, 25, fg: 82)
+puts canvas.render
+```
+
+## Use with rcurses
+
+Termchart is designed to compose with [rcurses](https://github.com/isene/rcurses) panes:
+
+```ruby
+require 'rcurses'
+require 'termchart'
+
+pane = Rcurses::Pane.new(2, 2, 60, 20)
+chart = Termchart::Line.new(width: 60, height: 20)
+chart.add(data, color: 82, label: "Price")
+pane.text = chart.render
+pane.refresh
+```
+
+## License
+
+Unlicense — Public Domain
+
+## Author
+
+Geir Isene — https://isene.com

data/lib/termchart/version.rb

@@ -1,3 +1,3 @@
 module Termchart
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termchart
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-20 00:00:00.000000000 Z
+date: 2026-03-04 00:00:00.000000000 Z
 dependencies: []
 description: Render sparklines, line charts (braille), candlestick charts, and bar
   charts as plain strings with ANSI color codes. Zero dependencies, pure Ruby.
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/termchart.rb
 - lib/termchart/bar.rb
 - lib/termchart/candle.rb