Skip to content

Update README with full API docs, examples, and chart screenshots#19

Merged
islubee merged 1 commit intomainfrom
claude/explore-repo-overview-aYE7G
Apr 15, 2026
Merged

Update README with full API docs, examples, and chart screenshots#19
islubee merged 1 commit intomainfrom
claude/explore-repo-overview-aYE7G

Conversation

@islubee
Copy link
Copy Markdown
Owner

@islubee islubee commented Apr 15, 2026

Summary

  • Rewrote README with a clear library description covering all 4 charts
  • Added per-chart prop tables and code examples for Timeline, ScatterPlot, Histogram, and BarChart
  • Added docs/ directory with actual Playwright-generated screenshots of each chart rendered with realistic sample data
  • Added sections on container sizing and CSS class customization
  • Fixed CI badge URL to use the current GitHub Actions workflow format

Screenshots

Timeline ScatterPlot
Histogram BarChart

Test plan

  • README renders correctly on GitHub with images visible
  • All 4 chart examples are accurate against the current API (xLabel/yLabel naming)
  • Screenshots load from docs/ relative paths

- Rewrote description covering all 4 charts (Timeline, ScatterPlot, Histogram, BarChart)
- Added per-chart prop tables, code examples, and screenshot previews
- Added full combined example and sections on sizing and CSS class customization
- Added docs/ directory with Playwright-generated PNG screenshots for each chart

https://claude.ai/code/session_01Bf9veNX9mqfMqrCEGnujAo
@islubee islubee merged commit fa156db into main Apr 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants