README rewrite + AEO Tier 3 submission drafts#98
Merged
Conversation
The README was a 100-line stub that pre-dated everything the docs now cover — no comparison table, no MCP-both-directions story, no Go/Python plugin treatment, missing Ollama under providers, no links to the Tier 2 landing pages (compare/*, FAQ, declarative-agent-framework, the no-code guide). This rewrite brings the README in line with the docs: - Badges (release, license, downloads, docs) - One-paragraph definition that matches docs.squadron.sh/ - Example mission with router block (more representative than the old one) - Why Squadron section: workflows as config, resilient by default, plugins in two languages, MCP both directions, mix providers per task, scheduled / webhook / budgeted, command center - Comparison table linking to the four /compare/* pages - "What's in the box" feature list with link-outs to docs - Learn-more section pointing to all the new Tier 2 pages Also adds aeo/ with submission-ready drafts: - aeo/awesome-list-submissions.md — exact PR text for awesome-ai-agents, awesome-mcp-clients, and awesome-langchain. Includes the patch to insert, target file, PR title, and PR body for each. - aeo/github-repo-metadata.md — proposed repo description and 15 topics with rationale and ready-to-run gh CLI commands. Not applied yet — this commit only stages the proposal for review. No code changes. Docs site is unchanged.
After auditing pulse on the three originally drafted target lists: - awesome-ai-agents (e2b-dev): 27.8k stars but last pushed Feb 2025, zero merged community PRs over the recent window, 646 open issues. Effectively abandoned. Dropped. - awesome-langchain (kyrolabs): 9.3k stars, maintainer-active (recent direct commits) but closes every community PR unmerged — a closed garden. Dropped. - awesome-mcp-clients (punkpeye): 6.4k stars, recent merges, active maintainer. Kept. aeo/awesome-list-submissions.md now contains only the mcp-clients submission, plus a "lists evaluated and rejected" table documenting why the others were cut so we don't re-add them in a future pass. Also dropping AEO_PLAN.md item #15 (MCP server registry submissions). Squadron is fundamentally an MCP client; the built-in MCP host is a side feature, not worth the energy of advertising to MCP-server discovery surfaces. Tier 3 weight redistributes to aggregator submissions (#13) and launch blog posts (#14). Plan doc updated to mark #11 done, #15 dropped, and #12 narrowed.
Applied via gh api: - description → "Declarative multi-agent AI workflows in HCL. Single Go binary. Native MCP. Plugins in Go and Python." - topics (15) → ai-agents, agentic-workflows, agent-framework, multi-agent, multi-agent-systems, llm-orchestration, declarative, declarative-configuration, hcl, mcp, model-context-protocol, ai-framework, llm-tools, workflow-orchestration, golang Removed aeo/awesome-list-submissions.md — user is handling the awesome-mcp-clients submission directly. AEO_PLAN.md marked #11 done.
Repo description and 15 topics are live on github.com/mlund01/squadron. No need for an aeo/github-repo-metadata.md record.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Tier 3 of the AEO plan — off-site signal. This PR delivers two of the items:
README changes
The previous README (`README.md` on main, ~100 lines) pre-dated everything the docs now cover. This rewrite brings it in line:
Awesome-list drafts (`aeo/awesome-list-submissions.md`)
Targets chosen after a structural audit of the major active lists:
For each accepted target, the doc has: target URL, exact insertion point, the patch to paste, PR title, and PR body. You fork, apply, submit.
GitHub metadata (`aeo/github-repo-metadata.md`)
Proposes:
Includes ready-to-run `gh` CLI commands. Not applied in this PR — these are visible public repo state, want explicit sign-off before pushing.
Why
The README is the second-most-linked Squadron URL after docs.squadron.sh. Awesome-list maintainers, HN/Reddit clickers, and AI crawlers all hit it first. Polishing it is the foundation for the next Tier 3 items (aggregator submissions, launch blog posts).
GitHub topics are a passive distribution channel — Squadron will surface in topic-browse pages (e.g. github.com/topics/ai-agents) for queries that match.
The awesome-list submissions are the highest-ROI off-site item in the plan: each accepted PR is a permanent, high-authority backlink with curated context.
Test plan
Out of scope