Skip to content

Add architecture, installation, quick start, and contributing to README #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
deepmasq wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add architecture, installation, quick start, and contributing to README #207

deepmasq wants to merge 1 commit into from

Conversation

@deepmasq
Copy link

@deepmasq deepmasq commented Feb 12, 2026

Summary

  • Add badges (Python version, license, PRs welcome) and quick navigation links
  • Add Architecture section with Mermaid diagram showing system topology
  • Add Features section (8 key capabilities derived from source)
  • Add Installation section (SDK install + self-hosted Docker setup)
  • Add Quick Start section (Frog bot: env vars → install → run → test)
  • Add Bot Gallery table (all 13 bots from flexus_simple_bots/)
  • Add minimal bot code example to "Writing Your Bot" section
  • Add Contributing section with fork/branch/test/PR workflow
  • Add License section

No existing content was removed.

Test plan

  • Verify Mermaid diagram renders on GitHub
  • Verify all internal links resolve (LICENSE, AGENTS.md, flexus_simple_bots/frog/)
  • Verify badge URLs load correctly
  • Verify code example in "Writing Your Bot" parses as valid Python

🤖 Generated with Claude Code

@claude
docs(readme): add architecture, installation, quick start, bot galler…
5aa8a2e 
…y, and contributing sections

Expand README from project overview to developer entry point: badges, Mermaid
architecture diagram, SDK install + self-hosted setup, Frog bot quick start,
bot gallery table, minimal bot code example, and contributing guidelines.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@deepmasq deepmasq added the documentation Improvements or additions to documentation label Feb 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@deepmasq