Certainly! Here’s a basic README template for your VS Code extension:
The AI Hopper Sidebar Extension for Visual Studio Code adds a custom sidebar view with buttons that open predefined URLs in your default browser. This extension is designed to enhance productivity by providing quick access to frequently used websites or resources directly from within the VS Code interface.
- Custom Sidebar View: Integrates a custom sidebar view within VS Code.
- Quick Access Buttons: Buttons for opening predefined URLs.
- Dynamic Webview: Uses VS Code's webview API to display HTML content.
- Simple Configuration: Easily customizable URLs directly within the extension code.
You can install the AI Hopper Sidebar Extension directly from the Visual Studio Code Marketplace or by following these steps:
- Launch VS Code.
- Go to the Extensions view (
Ctrl+Shift+X
orCmd+Shift+X
on macOS). - Search for "AI Hopper Sidebar Extension".
- Click on Install to install it.
- Reload VS Code.
Once installed, follow these steps to use the AI Hopper Sidebar Extension:
- Open the Command Palette (
Ctrl+Shift+P
orCmd+Shift+P
on macOS). - Search for and select Show Sidebar.
- The sidebar will appear with buttons labeled for different URLs.
- Click on any button to open the corresponding URL in your default web browser.
To customize the URLs that the buttons open:
- Open the
sidebarView.ts
file in your extension's source code. - Locate the
_getHtmlForWebview
method. - Update the URLs within the
<button>
elements to your desired links.
Example:
<button onclick="openUrl('https://example.com')">Open Example</button>
- Save your changes.
- Reload VS Code to apply the modifications.
Contributions to the AI Hopper Sidebar Extension are welcome! Here are ways you can contribute:
- Report bugs or suggest new features by opening an issue.
- Submit pull requests for fixes or improvements.
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to customize this README further based on additional features or specific details about your extension. Providing clear instructions and examples will help users understand how to use and extend your VS Code extension effectively.