Skip to content

docs: comprehensive README update#600

Open
gnuhpc wants to merge 2 commits into
apache:mainfrom
gnuhpc:docs/update-readme
Open

docs: comprehensive README update#600
gnuhpc wants to merge 2 commits into
apache:mainfrom
gnuhpc:docs/update-readme

Conversation

@gnuhpc
Copy link
Copy Markdown

@gnuhpc gnuhpc commented Jun 4, 2026

Summary

Comprehensive update of the root README.md to provide a complete and accurate overview of the project.

Changes

New Content

  • Badges: Added crates.io, docs.rs, and license badges
  • Features matrix: Full capability table for the core client (connection, admin, log tables, KV tables, data types, storage, WASM)
  • Language bindings overview: Rust/Python/C++/Elixir comparison table with package, async runtime, and data format
  • Project structure tree: ASCII directory layout with module responsibilities
  • KV table example: New upsert + point lookup code example
  • All 5 examples: Table with descriptions for log table, KV table, partitioned, prefix lookup variants
  • Configuration reference: Key config options with defaults and descriptions
  • Development section: Build/test instructions for all language bindings

Fixes

  • Replaced outdated Args / ConnectionConfig API with current Config
  • Examples now use proper Result<()> error handling instead of unwrap()
  • Updated all code examples to use current builder patterns (Schema::builder(), TableDescriptor::builder())
  • Clarified in the opening paragraph that this is a client SDK, not the Fluss server

Structure

  • Clear section hierarchy with separators
  • Quick Start with both log table and KV table examples
  • Concise inline code blocks for easy copy-paste

warmbupt added 2 commits June 4, 2026 10:55
- Add crates.io, docs.rs, and license badges
- Add feature matrix and language bindings overview tables
- Add project structure tree diagram
- Add KV table (upsert + lookup) code example
- Update log table example to use current Config API
- Add configuration reference table
- Add all 5 examples with descriptions
- Add development setup instructions
- Fix outdated API usage (Args → Config, ConnectionConfig → Config)
- Add proper error handling (Result<?>) instead of unwrap()
- Add crates.io, docs.rs, and license badges
- Add feature matrix and language bindings overview tables
- Add project structure tree diagram
- Add KV table (upsert + lookup) code example
- Update log table example to use current Config API
- Add configuration reference table
- Add all 5 examples with descriptions
- Add development setup instructions
- Fix outdated API usage (Args → Config, ConnectionConfig → Config)
- Add proper error handling (Result<?>) instead of unwrap()
- Clarify this is a client SDK, not the server
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