add LICENSE file and update README with detailed features and usage instructions

2025-12-17 11:09:57 +08:00
parent 0f2f70324b
commit 067bad6eef
3 changed files with 129 additions and 30 deletions
--- a/21
+++ b/21
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/README.md
+++ b/README.md
@@ -1,16 +1,44 @@
 # WizGIT for VS Code

-![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/your-publisher.wizgit-in-vscode?style=for-the-badge&label=Marketplace)
+![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/terencecarrera.wizgit-in-vscode?style=for-the-badge&label=Marketplace)
 ![License](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)

-Your intelligent coding companion for repository management, right inside Visual Studio Code. WizGIT simplifies repository creation and management with seamless API integration.
+Your intelligent coding companion for comprehensive repository management, right inside Visual Studio Code. WizGIT provides seamless integration with your WizGit for repositories, issues, and pull requests.

 ## Features

-*   **Repository Creation:** Easily create new repositories on WizGit directly from VS Code using the WizGit API.
-*   **Secure Authentication:** Safely authenticate using your WizGit Personal Access Token.
-*   **Progress Tracking:** Visual progress indication during repository creation with detailed status updates.
-*   **Error Handling:** Comprehensive error reporting for troubleshooting API issues.
+### 🏠 **Dedicated Activity Bar**
+*   **Custom WizGIT sidebar** with organized views for repositories, issues, and pull requests
+*   **Quick access** to all WizGIT functionality from the activity bar
+
+### 📁 **Repository Management**
+*   **Create repositories:** Easily create new repositories on WizGit directly from VS Code
+*   **Clone repositories:** Clone existing repositories with integrated UI
+*   **Repository discovery:** Automatic workspace detection and repository listing
+*   **Refresh functionality:** Keep your repository list up-to-date
+
+### 🐛 **Issue Management** 
+*   **Create issues:** Create new issues with intelligent workspace auto-detection
+*   **Repository auto-detection:** Automatically populate organization and repository from your workspace
+*   **Branch selection:** Choose target branch from a list of available branches (local and remote)
+*   **Context integration:** Create issues from file explorer or editor context menu
+
+### 🔀 **Pull Request Management**
+*   **Create pull requests:** Create PRs with comprehensive file change detection
+*   **File changes display:** View detailed file modifications and diffs
+*   **Smart branch selection:** Choose source and destination branches with intelligent defaults
+*   **Workspace integration:** Auto-detect repository information from your current workspace
+
+### 🔐 **Authentication & Security**
+*   **Secure token storage:** Safely store and manage your WizGit Personal Access Token
+*   **Configuration management:** Easy setup and configuration clearing options
+*   **API endpoint flexibility:** Support for custom WizGit/Gitea instances
+
+### ⚙️ **Smart Features**
+*   **Workspace detection:** Automatically identify Git repositories and extract owner/repo information
+*   **Branch enumeration:** List and select from available local and remote branches  
+*   **Progress tracking:** Visual progress indication during operations
+*   **Error handling:** Comprehensive error reporting and troubleshooting

 ## Requirements

@@ -18,46 +46,91 @@ Your intelligent coding companion for repository management, right inside Visual
 *   A valid WizGit account with API access.
 *   Personal Access Token from your WizGit instance.

-## Usage
+## Getting Started

-1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
-2. Run the command: `WizGIT: Create Repository`
-3. Follow the prompts to enter:
-   - Your WizGit API endpoint (e.g., `https://wizgit.com/api/v1`)
-   - Your Personal Access Token
-   - Repository name
-   - Repository description (optional)
+### Initial Setup
+1. **Configure WizGIT:** Open Command Palette (`Ctrl+Shift+P`) and run `WizGIT: Configure WizGIT`
+2. **Enter your details:**
+   - WizGit API endpoint (e.g., `https://your-wizgit-instance.com/api/v1`)
+   - Personal Access Token from your WizGit instance
+3. **Access the sidebar:** Click the WizGIT icon in the activity bar to open the dedicated sidebar

-The extension will create the repository and notify you of the result.
+### Creating Repositories
+1. In the WizGIT sidebar, go to the **Repositories** view
+2. Click the "Create Repository" button (➕) in the title bar
+3. Fill in repository details and click "Create Repository"
+
+### Managing Issues  
+1. In the **Issues** view, click "Create Issue" (🐛)
+2. The extension will automatically detect your workspace repository
+3. Choose the target branch from the dropdown list
+4. Fill in issue title and description, then submit
+
+### Creating Pull Requests
+1. In the **Pull Requests** view, click "Create Pull Request" (🔀)
+2. Select source and destination branches
+3. Review the automatically detected file changes
+4. Add title and description, then create the PR
+
+### Alternative Access Methods
+- **Command Palette:** All commands are available via `Ctrl+Shift+P` 
+- **Context Menus:** Right-click in file explorer or editor to create issues
+- **Keyboard Shortcuts:** Assign custom shortcuts to frequently used commands

 ## Commands

-*   `WizGIT: Create Repository` - Creates a new repository on your WizGit instance
+### Repository Commands
+*   `WizGIT: Configure WizGIT` - Set up API endpoint and authentication
+*   `WizGIT: Create Repository` - Create a new repository
+*   `WizGIT: Clone Repository` - Clone an existing repository
+*   `WizGIT: Clear Configuration` - Remove stored authentication data
+
+### Issue & PR Commands  
+*   `WizGIT: Create Issue` - Create a new issue with workspace auto-detection
+*   `WizGIT: Create Pull Request` - Create a pull request with file change detection

 ## Extension Settings

-Currently, this extension does not contribute any settings. All configuration is done through the interactive prompts when creating a repository.
+This extension contributes the following settings:
+
+*   `wizgit.apiEndpoint` - Your WizGIT API endpoint URL
+*   `wizgit.autoDetect` - Automatically detect WizGIT repositories in workspace (default: `true`)
+*   `wizgit.statusBar.enabled` - Show WizGIT information in status bar (default: `true`)  
+*   `wizgit.notifications.enabled` - Enable WizGIT notifications (default: `true`)
+*   `wizgit.defaultBranch` - Default branch name for new repositories (default: `master`)
+
+You can access these settings through VS Code's Settings UI or by adding them to your `settings.json`.

 ## Known Issues

-*   Network connectivity issues may cause repository creation to fail.
-*   Please report any bugs or feature requests on our [GitHub Issues](https://github.com/your-repo/wizgit-in-vscode/issues) page.
+*   Network connectivity issues may cause API operations to fail
+*   File change detection for pull requests may not work with all repository configurations
+*   Workspace auto-detection requires a valid Git repository with remote origin configured
+*   Please report any bugs or feature requests on our [Issues page](http://126.209.24.132/terence.carrera/wizgit-vscode-extension/issues)

 ## Release Notes

+### 0.0.2 (Current)
+
+Major feature expansion and UI improvements:
+* **New dedicated activity bar** with custom WizGIT sidebar
+* **Issue management** with workspace auto-detection and branch selection
+* **Pull request creation** with file change detection and diff display
+* **Repository cloning** functionality
+* **Workspace integration** - automatic repository detection from Git remotes
+* **Branch enumeration** - list and select from local/remote branches
+* **Context menu integration** - create issues from explorer and editor
+* **Enhanced configuration** - comprehensive settings and token management
+* **Improved error handling** and user experience
+* **Custom branding** with WizGIT logo and theming
+
 ### 0.0.1

-Initial release of WizGIT.
-* Core feature: Create repositories via WizGit API.
-* Interactive prompts for API configuration.
-* Progress tracking and error handling.
-
-### 0.0.2
-Added detailed error messages and improved user prompts.
-* Enhanced user experience with clearer instructions.
-* Bug fixes and performance improvements.
-* Updated documentation.
+Initial release of WizGIT:
+* Core repository creation via WizGit API
+* Basic authentication and configuration
+* Progress tracking and error handling

 ---

-**Enjoy streamlined repository management with WizGIT!**
+**Enjoy comprehensive repository management with WizGIT! 🪄✨**
--- a/package.json
+++ b/package.json
@@ -4,6 +4,11 @@
    "description": "A VS Code extension to interact with WizGIT API for repository management.",
    "version": "0.0.2",
    "publisher": "TerenceCarrera",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "http://126.209.24.132/terence.carrera/wizgit-vscode-extension"
+    },
    "engines": {
        "vscode": "^1.74.0"
    },