Add readme for NuGet packages

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

src/Velopack.Vpk/Velopack.Vpk.csproj

@@ -6,12 +6,13 @@
     <IsPackable>true</IsPackable>
     <AssemblyName>vpk</AssemblyName>
     <PackageId>vpk</PackageId>
+    <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
     <Title>Velopack CLI</Title>
     <ToolCommandName>vpk</ToolCommandName>
     <DevelopmentDependency>true</DevelopmentDependency>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackAsTool>true</PackAsTool>
-    <Description>A .NET Core Tool that uses the Velopack framework to create installers and update packages for dotnet applications.</Description>
+    <Description>A .NET Core Tool to build Velopack releases.</Description>
     <PackageIcon>Velopack_200.png</PackageIcon>
     <LangVersion>latest</LangVersion>
     <NoWarn>$(NoWarn);CA2007;CS8002</NoWarn>
@@ -19,6 +20,7 @@
 
   <ItemGroup>
     <None Include="..\..\docs\artwork\Velopack_200.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(Configuration)' == 'Debug'">

src/Velopack/Velopack.csproj

@@ -3,20 +3,25 @@
 
   <PropertyGroup>
     <TargetFrameworks>net462;net48;netstandard2.0;net5.0;net6.0;net8.0</TargetFrameworks>
-    <Description>Velopack</Description>
-    <Title>Velopack</Title>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <PackageId>Velopack</PackageId>
-    <Description>Quick and easy installer and automatic updates for desktop applications</Description>
-    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <PackageIcon>Velopack_200.png</PackageIcon>
     <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
     <LangVersion>9</LangVersion>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <Title>Velopack</Title>
+    <Description>Velopack</Description>
+    <PackageId>Velopack</PackageId>
+    <PackageIcon>Velopack_200.png</PackageIcon>
+    <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
+    <Description>Quick and easy installer and automatic updates for cross-platform desktop applications</Description>
+    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+  </PropertyGroup>
+
   <ItemGroup>
     <None Include="..\..\docs\artwork\Velopack_200.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>