diff --git a/README_NUGET.md b/README_NUGET.md new file mode 100644 index 00000000..3d3da75e --- /dev/null +++ b/README_NUGET.md @@ -0,0 +1,13 @@ +# Velopack +Velopack is a setup / installation framework for cross-platform dotnet applications. Great out-of-the-box development experience, with zero configuration or setup needed. Lightning fast to use, and lightning fast for your users, too. + +## Features + +- 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and update package in a single command. +- 🎯 **Cross platform** – Velopack supports building packages for Windows and OSX, with Linux on the way. No matter your target, Velopack can create a release in just one command. +- 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](docs/migrating.md) +- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for fast app updates. Applying update packages is highly optimised, and often can be done in the background. + +## Getting Started + +Please visit our GitHub for up to date documentation on how to use Velopack: https://github.com/velopack/velopack \ No newline at end of file diff --git a/src/Velopack.Vpk/Velopack.Vpk.csproj b/src/Velopack.Vpk/Velopack.Vpk.csproj index 67608e27..a67b9d56 100644 --- a/src/Velopack.Vpk/Velopack.Vpk.csproj +++ b/src/Velopack.Vpk/Velopack.Vpk.csproj @@ -6,12 +6,13 @@ true vpk vpk + README_NUGET.md Velopack CLI vpk true true true - A .NET Core Tool that uses the Velopack framework to create installers and update packages for dotnet applications. + A .NET Core Tool to build Velopack releases. Velopack_200.png latest $(NoWarn);CA2007;CS8002 @@ -19,6 +20,7 @@ + diff --git a/src/Velopack/Velopack.csproj b/src/Velopack/Velopack.csproj index aa9a6330..cf5ec07d 100644 --- a/src/Velopack/Velopack.csproj +++ b/src/Velopack/Velopack.csproj @@ -3,20 +3,25 @@ net462;net48;netstandard2.0;net5.0;net6.0;net8.0 - Velopack - Velopack true - Velopack - Quick and easy installer and automatic updates for desktop applications - true - Velopack_200.png true false 9 + + Velopack + Velopack + Velopack + Velopack_200.png + README_NUGET.md + Quick and easy installer and automatic updates for cross-platform desktop applications + true + + +