Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update metadata for initial release #5

Merged
merged 2 commits into from
Mar 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file removed assets/hello-world.png
Binary file not shown.
Binary file added assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading