Update README.md

This commit is contained in:
Caelan Sayler
2021-12-06 18:32:56 +00:00
committed by GitHub
parent 5eb801e9b5
commit 3b7caed2a5

View File

@@ -92,20 +92,28 @@ Windows apps should be as fast and as easy to install and update as apps like Go
- A list of supported runtimes for the `--framework` argument is [available here](https://github.com/clowd/Clowd.Squirrel/blob/develop/src/Setup/RuntimeInfo.cpp)
6. Distribute your entire `--releaseDir` folder online. This folder can be hosted on any static web/file server, [Amazon S3](docs/using/amazon-s3.md), BackBlaze B2, or even via [GitHub Releases](docs/using/github.md).
- Note: If using CI to deploy releases, you can use the package syncing commands to download the currently live version, before creating a package. This means delta/patch updates can be generated. Complete powershell example:
```ps1
# build / publish your app
dotnet publish -c Release -o ".\publish"
# find Squirrel.exe path and add an alias
Set-Alias Squirrel ($env:USERPROFILE + "\.nuget\packages\clowd.squirrel\2.6.2-pre\tools\Squirrel.exe");
# download currently live version
Squirrel http-down --url "https://the.place/you-host/updates"
# build new version and delta updates. Will also bootstrap 'net6' runtime during setup if not installed already.
Squirrel pack --framework net6 --packName "YourApp" --packVersion "1.0.0" --packAuthors "YourCompany" --packDirectory ".\publish"
```
If using CI to deploy releases, you can use the package syncing commands to download the currently live version, before creating a package. This means delta/patch updates can be generated. Complete powershell example:
```ps1
# build / publish your app
dotnet publish -c Release -o ".\publish"
# find Squirrel.exe path and add an alias
Set-Alias Squirrel ($env:USERPROFILE + "\.nuget\packages\clowd.squirrel\2.6.2-pre\tools\Squirrel.exe");
# download currently live version
Squirrel http-down --url "https://the.place/you-host/updates"
# build new version and delta updates.
Squirrel pack`
--framework net6` # Install .NET 6.0 during setup, if required
--packName "YourApp"` # Application / package name
--packVersion "1.0.0"` # Version to build. Should be supplied by your CI
--packAuthors "YourCompany"` # Your name, or your company name
--packDirectory ".\publish"` # The directory the application was published to
--setupIcon "mySetupIcon.ico"` # Icon for Setup.exe
--splashImage "install.gif" # The splash artwork (or animation) to be shown during install
```
7. Update your app on startup / periodically with UpdateManager.
```cs