From 64cc7492adfd1623a544bfe6fa56d7d78aab41d5 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 19 Nov 2020 18:20:42 -0500 Subject: [PATCH] improve usage summary --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 529330d..0b1a95d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ **gitdeploy** is an app for continuous deployment of static websites. +1. Point a domain to a server running `gitdeploy` +2. [Set git webhooks](#add-webhooks) (Github, Gitea, Bitbucket, etc) +3. Create [build & deploy scripts](#setup-with-deploy-scripts) from the examples +4. Profit (when you push, the build will kick off) + ## Features **gitdeploy** is intended for use with static websites that are generated after @@ -53,7 +58,7 @@ Usage of gitdeploy run: ## Install You can download `gitdeploy` from the Github Releases API and place it in your PATH, -or install it with [Webi](https://webinstall.dev) ([webinstall.dev](https://webinstall.dev)): +or install it with [Webi](https://webinstall.dev) ([webinstall.dev/gitdeploy](https://webinstall.dev/gitdeploy)): **Mac**, **Linux**: @@ -67,6 +72,10 @@ curl -sS https://webinstall.dev/gitdeploy | bash curl -A MS https://webinstall.dev/gitdeploy | powershell ``` +**Manual Install** + +See . + ## Git SSH Deploy Keys and Tokens All of the clone URLs are HTTPS clone URLs.