Skip to content

docs(readme): professional README overhaul for open-source launch#439

Merged
genedna merged 13 commits into
libra-tools:mainfrom
wingwangsz:main
Jul 14, 2026
Merged

docs(readme): professional README overhaul for open-source launch#439
genedna merged 13 commits into
libra-tools:mainfrom
wingwangsz:main

Conversation

@wingwangsz

Copy link
Copy Markdown
Contributor

Summary

Complete overhaul of Libra's README for open-source community launch, with both English (README.md) and Chinese (README.zh-CN.md) versions.

Changes

Structure

  • Hero section with banner, positioning statement, and vision/mission
  • Compact badge row (CI, License, Discord, X, Docs)
  • Key Differentiators comparison table (Git vs Libra)
  • Quick Start (Install → Init → Use Agent Capture)
  • Core Features (6 emoji cards)
  • Supported AI Providers (concise one-liner)
  • Community & Resources table

Content

  • Added AI-native positioning: "Versioning the entire software creation lifecycle, not just code"
  • Added copyright line for GitMono Limited
  • Updated Discord invite link
  • Replaced provider list with agent list (Claude Code, CodeX, OpenCode)
  • Removed redundant sections: Architecture, Multi-Agent Collaboration, AI-Native Subcommands

Assets

  • Added project banner (docs/image/libra-banner.png)
  • Added logo SVG (docs/image/libra-logo.svg)

LICENSE

  • Updated copyright year to 2025-2026
  • Added GitMono Limited copyright

Files Changed

  • README.md — full rewrite (340 insertions, 605 deletions)
  • README.zh-CN.md — new Chinese README
  • LICENSE — copyright update
  • docs/image/libra-banner.png — new banner
  • docs/image/libra-demo.png — demo screenshot
  • docs/image/libra-logo.svg — logo

- Rewrite README.md with clear AI-native positioning and vision/mission
- Add README.zh-CN.md for Chinese developers
- Add new banner, logo, and demo screenshot assets
- Update LICENSE copyright year to 2025-2026
- Include community links (Discord, X, docs, website)
- Add CI badge, license badge, and quick start guide
- Structure: Hero -> Badges -> Demo -> Quick Start -> Features -> Community
…, and redundant What is Libra? section

- Remove overly verbose vision statement (keep mission only)
- Remove demo screenshot to reduce visual weight
- Remove 'What is Libra?' section (redundant with hero title)
- Compact badges into single horizontal row without wrapper div
- Net -62 lines for cleaner, more scannable README
…raph

Restore the Git vs Libra comparison table after badges section.
Remove the verbose 'What is Libra?' intro text but retain the
differentiator table that users scanning from top expect to see.
…chitecture section

- Replace provider table with concise text: lists all 7 providers, switch with --provider
- Update docs link to /en/docs/getting-started/agent
- Remove Architecture section (details belong in docs site, not README)
…enter badges; fix doc links

- Split hero section: title and subtitle remain centered, description text left-aligned
- Wrap badges in <p align="center"> for centered layout
- Update Quick Start 'full documentation' link to /en/docs/getting-started
- Update bottom 'Get Started' link to /en/docs/getting-started
GitHub markdown parser ignores markdown inside <p> tags, causing
badge source code to render as raw text. <div align="center">
correctly centers badges while preserving markdown parsing.
… and AI-Native Subcommands sections

- Add 'Copyright (c) 2026 GitMono Limited' to LICENSE and both READMEs
- Remove Multi-Agent Collaboration section (provider switching examples)
- Remove AI-Native Subcommands section (command reference table)
…n Quick Start

- Replace libra code examples with agent capture workflow (enable -> run -> inspect)
- Update doc link to /en/docs/getting-started/agent
- Tiered storage: MinIO -> RustFS
- Supported AI Providers: replace provider list with Claude Code/CodeX/OpenCode
- Copyright lines already on separate lines (no change needed)
@genedna genedna merged commit 3dd5a23 into libra-tools:main Jul 14, 2026
7 of 9 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