Skip to content

Rewrite README with better structure, examples, and benchmarks#78

Open
jeandet wants to merge 2 commits intoSciQLop:mainfrom
jeandet:docs/improve-readme
Open

Rewrite README with better structure, examples, and benchmarks#78
jeandet wants to merge 2 commits intoSciQLop:mainfrom
jeandet:docs/improve-readme

Conversation

@jeandet
Copy link
Copy Markdown
Member

@jeandet jeandet commented Apr 10, 2026

Summary

  • Reorganize README around clear sections: highlights at the top, quick start guides, benchmarks, feature roadmap
  • Add verified Python examples: time conversions, compression, filtering, variable cloning, buffer protocol
  • Add C++ examples for writing and in-memory loading
  • Include SIMD time conversion and RLE compression benchmark tables from measured baselines
  • Consolidate CI badge tables and clean up prose

Test plan

  • Verify all code examples match actual API (cross-checked against test suite)
  • Confirm benchmark numbers match recorded baselines
  • Check markdown renders correctly on GitHub

🤖 Generated with Claude Code

Reorganize around clear sections (highlights, quick start, benchmarks,
features). Add verified code examples for time conversions, compression,
filtering, variable cloning, and C++ read/write. Include SIMD time
conversion and RLE compression benchmark tables.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.49%. Comparing base (e016059) to head (f57b32a).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #78      +/-   ##
==========================================
- Coverage   90.24%   89.49%   -0.76%     
==========================================
  Files          57       57              
  Lines        3446     3446              
==========================================
- Hits         3110     3084      -26     
- Misses        336      362      +26     
Flag Coverage Δ
unittests 89.49% <ø> (-0.76%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Add Linux aarch64 and Pyodide (wasm32) columns to the badge table.
Mention emscripten-forge availability with link to the recipe.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sonarqubecloud
Copy link
Copy Markdown

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.

1 participant