Skip to content

Update README.md#2296

Merged
cyyeh merged 2 commits into
mainfrom
cyyeh-patch-1
May 15, 2026
Merged

Update README.md#2296
cyyeh merged 2 commits into
mainfrom
cyyeh-patch-1

Conversation

@cyyeh
Copy link
Copy Markdown
Member

@cyyeh cyyeh commented May 15, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced the Quickstart section with expanded Wren skill installation instructions, including guidance for making skills available across multiple AI coding agents and an alternative installation method via script.

Review Change Stack

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 15, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

README.md Quickstart section expanded to provide two installation pathways for Wren skills: direct npx skills add command with --agent '*' multi-agent support, and an alternative method using the skills/install.sh script fetched from GitHub.

Changes

Quickstart Installation Guide

Layer / File(s) Summary
Skill installation instructions expansion
README.md
Quickstart step 1 instructions now provide both direct npx skills add command with multi-agent flag and an alternative installation via the shell script method.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Canner/WrenAI#2292: Both PRs update README.md's "Quickstart" instructions for installing/using Wren skills and include guidance around the skills/install.sh command, with directly overlapping documentation changes.

Suggested reviewers

  • chilijung
  • wwwy3y3

Poem

🐰 A quickstart blooms with paths so clear,
Two ways to install, both drawing near,
--agent '*' spreads the skill so wide,
And install.sh offers an alternate ride! 🎯

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update README.md' is vague and generic, using non-descriptive language that doesn't convey the specific nature of the changes made. Use a more descriptive title like 'Update README quickstart with expanded Wren skill installation instructions' to clearly communicate the main change to reviewers.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cyyeh-patch-1

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

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

@cyyeh cyyeh merged commit 6113135 into main May 15, 2026
1 of 3 checks passed
@cyyeh cyyeh deleted the cyyeh-patch-1 branch May 15, 2026 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants