From e3dfc07af3b9ffc07f7d3abf4bc57a3a853038dd Mon Sep 17 00:00:00 2001 From: Caelan Sayler Date: Sun, 14 Jan 2024 16:30:31 +0000 Subject: [PATCH] fix readme; we now support linux --- README.md | 7 ++++--- README_NUGET.md | 4 ++-- Velopack.sln | 1 + 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3ca7c4f8..c2f166e3 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ Velopack is a setup / installation framework for cross-platform dotnet applicati ## 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. +- 🎯 **Cross platform** – Velopack supports building packages for **Windows**, **OSX**, and **Linux**. 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. +- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for ultra fast app updates. Applying update packages is highly optimised, and often can be done in the background. ## Getting Started This is a very simple example of the steps you would take to generate an installer and update packages for your application. Be sure to [read the documentation](docs) for an overview of more features! @@ -27,7 +27,7 @@ This is a very simple example of the steps you would take to generate an install ```cmd dotnet tool install -g vpk ``` -2. Install the [Velopack NuGet Package](https://www.nuget.org/packages/velopack) in your main project: +2. Install the [Velopack NuGet Package](https://www.nuget.org/packages/velopack) in your main project: ```cmd dotnet add package Velopack ``` @@ -36,6 +36,7 @@ This is a very simple example of the steps you would take to generate an install static void Main(string[] args) { VelopackApp.Build().Run(); + // ... your other startup code below } ``` 4. Publish dotnet and build your first Velopack release! 🎉 diff --git a/README_NUGET.md b/README_NUGET.md index 3d3da75e..6e346a96 100644 --- a/README_NUGET.md +++ b/README_NUGET.md @@ -4,9 +4,9 @@ Velopack is a setup / installation framework for cross-platform dotnet applicati ## 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. +- 🎯 **Cross platform** – Velopack supports building packages for Windows and OSX, and Linux. 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. +- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for ultra fast app updates. Applying update packages is highly optimised, and often can be done in the background. ## Getting Started diff --git a/Velopack.sln b/Velopack.sln index d2109101..ce8edfa3 100644 --- a/Velopack.sln +++ b/Velopack.sln @@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionLevel", "SolutionLe .github\workflows\build.yml = .github\workflows\build.yml src\Directory.Build.props = src\Directory.Build.props test\Directory.Build.props = test\Directory.Build.props + nuget.config = nuget.config README.md = README.md Velopack.entitlements = Velopack.entitlements version.json = version.json