Skip to content

Add installation from source instructions to README#1

Merged
manvith12 merged 1 commit into
mainfrom
copilot/fix-b868ae65-4bfa-4c9d-a3e6-b49d1f69a3ab
Jul 11, 2025
Merged

Add installation from source instructions to README#1
manvith12 merged 1 commit into
mainfrom
copilot/fix-b868ae65-4bfa-4c9d-a3e6-b49d1f69a3ab

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jul 11, 2025

Summary

Adds a new section "🧩 How to Install the Extension from Source (Unpacked)" to the README.md file, providing clear step-by-step instructions for users who want to install the extension directly from source code.

Changes Made

  • Added new installation section above the "Key Features" section in README.md

  • Included 6 detailed steps for installing from unpacked source:

    1. Download ZIP directly from GitHub releases (v1.0.0)
    2. Extract the ZIP file
    3. Open chrome://extensions/ in Chromium-based browsers
    4. Enable Developer mode
    5. Load unpacked extension
    6. Verify installation
  • Added benefit note highlighting that no .crx file is needed for full source control

Why This Change?

This addition provides users with an alternative installation method that:

  • Gives users full control over the source code
  • Allows for easy modification and customization
  • Provides transparency in what the extension does
  • Offers a simple installation process without requiring packaged .crx files

The new section is strategically placed before "Key Features" to ensure users see installation options early in the documentation flow.

This pull request was created as a result of the following prompt from Copilot chat.

Add a section titled "## 🧩 How to Install the Extension from Source (Unpacked)" in the README.md file above the "Key Features" section. The section should include the following steps:

  1. Download the ZIP directly.
  2. Extract the ZIP file to a folder on your system.
  3. Open chrome://extensions/ in your Chromium-based browser (Chrome, Edge, Brave, etc.).
  4. Enable "Developer mode" (toggle in the top right corner).
  5. Click "Load unpacked" and select the extracted folder.
  6. The extension will now be installed and active.

✅ No .crx needed — full control with source installation.

Place this new section above the "Key Features" section in README.md.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jul 11, 2025

🧙 Sourcery has finished reviewing your pull request!


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

@manvith12 manvith12 marked this pull request as ready for review July 11, 2025 07:29
@manvith12 manvith12 merged commit c949910 into main Jul 11, 2025
1 check passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 11, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copilot AI changed the title [WIP] Add installation instructions for unpacked extension to README.md Add installation from source instructions to README Jul 11, 2025
Copilot AI requested a review from manvith12 July 11, 2025 07:32
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.

2 participants