diff --git a/README.md b/README.md index 03d1b66..6582b41 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ -# vscode-nuget-installer README +# VS Code NuGet Installer +## Overview + +The VS Code NuGet Installer is a Visual Studio Code extension designed to provide a graphical user interface (GUI) for managing NuGet packages within your .NET projects. It allows users to easily add, update, or remove NuGet packages from .csproj, .vbproj, .fsproj, or .sln files directly within the VS Code environment. + +## Features + +Manage NuGet Packages: Add, update, and remove NuGet packages from your .NET projects. +Project Detection: Automatically detects .csproj, .vbproj, .fsproj, or .sln files in your workspace. +NuGet Source Management: Configure and use multiple NuGet sources for package management. +Webview UI: A dedicated frontend interface for managing packages, built with modern web technologies. + +## Getting Started + +1. Installation: Install the extension from the Visual Studio Code Marketplace. +2. Open a .NET Project: Open your .NET project folder in VS Code. +3. Access the GUI: Right-click on a .csproj, .vbproj, .fsproj, or .sln file in the Explorer panel and select "Manage Nuget Packages". + +## Configuration + +The extension allows configuration of NuGet sources and other settings through the VS Code settings.json file. For example, to specify a custom NuGet source: +Refer to the package.json file for a full list of configurable settings. + +## Development + +### Prerequisites + +* Node.js +* npm + +### Setup + +1. Clone the repository. +2. Install dependencies by running npm install in the root directory and the webview-ui directory. +Running Locally +To start the webview UI in development mode, run npm run start:webview from the root directory. +To compile the TypeScript source, run npm run compile. + +### Building + +To build the webview UI, run npm run build:webview. +To package the extension for distribution, run npm run vscode:prepublish. + +## Contributing +Contributions are welcome! Please read the contributing guidelines before submitting pull requests. + +## License +This project is licensed under the MIT License - see the LICENSE file for details. \ No newline at end of file diff --git a/assets/hello-world.png b/assets/hello-world.png deleted file mode 100644 index 9328e55..0000000 Binary files a/assets/hello-world.png and /dev/null differ diff --git a/assets/icon.png b/assets/icon.png new file mode 100644 index 0000000..2c5c911 Binary files /dev/null and b/assets/icon.png differ diff --git a/package.json b/package.json index 961d27c..72c0679 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "description": "GUI to install nuget packages", "version": "0.0.1", "publisher": "kavod-io", + "icon": "assets/icon.png", "repository": { "type": "git", "url": "https://github.com/kavod-io/vscode-nuget-installer"