Skip to content

README: badges, top install line, npm name disclaimer - #150

Merged
yourconscience merged 1 commit into
mainfrom
docs/discoverability
Aug 24, 2026
Merged

README: badges, top install line, npm name disclaimer#150
yourconscience merged 1 commit into
mainfrom
docs/discoverability

Conversation

@yourconscience

@yourconscience yourconscience commented Aug 24, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Documentation:

  • Add release, Homebrew, npm, CI, and license badges, a prominent Homebrew installation command, and a disclaimer distinguishing the scoped npm package from the unscoped dotagents package.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @yourconscience, you have reached your weekly rate limit of 250000 diff characters.

Please try again later or upgrade to continue using Sourcery

@sourcery-ai

sourcery-ai Bot commented Aug 24, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The README now surfaces key project status and distribution links, puts the primary Homebrew install command upfront, and distinguishes the scoped npm package from the unrelated unscoped package.

File-Level Changes

Change Details Files
Improved the README’s installation and project-discovery section with status badges, a prominent Homebrew command, and npm package naming clarification.
  • Added badges linking to releases, Homebrew, npm, CI, and the MIT license.
  • Added a copy-ready Homebrew installation command near the top of the README.
  • Clarified that the project publishes under the scoped npm package name and is unaffiliated with the unscoped package.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@yourconscience
yourconscience merged commit 4b07622 into main Aug 24, 2026
5 checks passed
@yourconscience
yourconscience deleted the docs/discoverability branch August 24, 2026 14:51
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.

1 participant