Mirrors/velopack
1
0
Fork 0
mirror of https://github.com/velopack/velopack.git synced 2025-10-25 15:19:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme's to point to new docs

Browse Source
This commit is contained in:
Caelan Sayler
2024-01-27 13:01:31 +00:00
parent a4d330c235
commit b51aa414c5
4 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/docs.yml vendored
View File

@@ -1,6 +1,6 @@
# Your GitHub workflow file under .github/workflows/ # Your GitHub workflow file under .github/workflows/
# Trigger the action on push to main # Trigger the action on push to main
name: Deploy Docs name: Docs
on: on:
push: push:
@@ -20,7 +20,7 @@ concurrency:
cancel-in-progress: false cancel-in-progress: false
jobs: jobs:
publish-docs: deploy:
environment: environment:
name: github-pages name: github-pages
url: ${{ steps.deployment.outputs.page_url }} url: ${{ steps.deployment.outputs.page_url }}

6
README.md
View File

@@ -24,7 +24,7 @@ https://github.com/velopack/velopack/assets/1287295/0ff1bea7-15ed-42ae-8bdd-9519
## Getting Started ## 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! 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](https://velopack.io/docs/) for an overview of more features!
1. Install the command line tool `vpk`: 1. Install the command line tool `vpk`:
```cmd ```cmd
@@ -69,7 +69,7 @@ This is a very simple example of the steps you would take to generate an install
If you're not sure how these instructions fit into your app, check the example apps for common scenarios such as WPF or Avalonia. If you're not sure how these instructions fit into your app, check the example apps for common scenarios such as WPF or Avalonia.
## Documentation ## Documentation
- 📖 [Read the docs](docs) - 📖 [Read the docs](https://velopack.io/docs/)
- 🕶️ [View example apps](examples) - 🕶️ [View example apps](examples)
## Community ## Community
@@ -78,7 +78,7 @@ If you're not sure how these instructions fit into your app, check the example a
## Contributing ## Contributing
- 💬 Join us on [Discord](https://discord.gg/CjrCrNzd3F) to get involved in dev discussions - 💬 Join us on [Discord](https://discord.gg/CjrCrNzd3F) to get involved in dev discussions
- 🚦 Read our [compiling guide](docs/compiling.md) - 🚦 Read our [compiling guide](https://velopack.io/docs/compiling.html)
## Testimonials ## Testimonials
I have now got my external facing application using velopack. I am very impressed. Seems to work fabulously well and be much faster both in the initial build and in the upgrading of the software on the end user's machine than Squirrel was. It's amazing and the best installer I've ever used in over 30 years of development. Thanks so much! You are doing some great work! I have now got my external facing application using velopack. I am very impressed. Seems to work fabulously well and be much faster both in the initial build and in the upgrading of the software on the end user's machine than Squirrel was. It's amazing and the best installer I've ever used in over 30 years of development. Thanks so much! You are doing some great work!

3
README_NUGET.md
View File

@@ -10,4 +10,5 @@ Velopack is an installation and auto-update framework for cross-platform .NET ap
## Getting Started ## Getting Started
Please visit our GitHub for up to date documentation on how to use Velopack: https://github.com/velopack/velopack - Visit our GitHub: https://github.com/velopack/velopack
- Read the documentation: https://velopack.io/docs/

1
docfx/README.md Normal file
View File

@@ -0,0 +1 @@
If you've reached this page, you're probably [looking for the documentation](https://velopack.io/docs/).