chore(readme + version): updated readme with tui + upgraded version i…

[ChrisCoder9000]

…nto readme

Summary by CodeRabbit

• Documentation

  • Substantially expanded installation and usage documentation for the BrainAPI command-line interface, including setup workflow, command reference, and configuration options.
  • Added "Get Started" navigation link and updated development version badge.
  • Documented alternative installation methods and updated ML extras setup information.
  • Added command-line interface reference to resources table.

• Chores

  • Bumped development version to 2.12.0-dev.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 904309a7-be03-411d-aba4-c8931fc53e5a

📥 Commits

Reviewing files that changed from the base of the PR and between d067193 and 7b96cd1.

📒 Files selected for processing (2)

• README.md
• pyproject.toml

---

📝 Walkthrough

Walkthrough

This PR updates BrainAPI documentation and version metadata. The version is bumped from 2.11.12-dev to 2.12.0-dev across README badge and pyproject.toml, while README content is substantially expanded to document TUI usage, installation alternatives, and resource references.

Changes

Documentation and Version Alignment

Layer / File(s)	Summary
Version synchronization README.md, pyproject.toml	Version badge and project version field updated from 2.11.12-dev to 2.12.0-dev.
TUI documentation and resource updates README.md	Navigation link added for "Get Started". "Try It Now" section expanded with comprehensive brainapi TUI workflow (init/start/config/doctor/update commands, setup wizard configuration, install paths/state/config, environment overrides), alternative setup instructions (clone-from-source with poetry/make, local TUI build, Docker-only), and optional dependencies refreshed to document .env-gating and make commands. Docling OCR instructions reworded to reference TUI's install-extras script integration. Resources table gains new "Local CLI (TUI)" row.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Lumen-Labs/brainapi2#49: Both PRs make substantial, overlapping documentation changes to README.md, including "Try It Now" and resources sections.
• Lumen-Labs/brainapi2#58: Both PRs update the README version badge and bump the package version in pyproject.toml.
• Lumen-Labs/brainapi2#30: Both PRs bump the project version string in pyproject.toml and update the README version badge.

Poem

🐰 A version bump and docs expand,
TUI workflows in our gentle paw,
From badge to badge the numbers dance,
Two-twelve-oh-dev now takes its stance,
With guides for all to understand our craft. ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch development

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}