From 6243ce454acd195618ec97bf660af7fb07941eae Mon Sep 17 00:00:00 2001 From: Tyler Cook <10459406+cilki@users.noreply.github.com> Date: Tue, 12 Mar 2024 20:58:27 -0500 Subject: [PATCH] docs: update readme --- .github/workflows/build.yml | 2 +- README.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 329eeb5..b83cceb 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -12,7 +12,7 @@ jobs: uses: actions/checkout@v4 - name: Build goldboot image - uses: fossable/goldboot-action@master + uses: fossable/goldboot-action@main with: output: image.gb diff --git a/README.md b/README.md index 79071d4..12a4fa3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ ## goldboot template +To get started quickly, you can use this repository as a template! Just +follow the below instructions: + +1. Click the **Use this template** button at the top of the repository +1. Select **Create a new repository** +1. Select an owner and name for your new repository +1. Click **Create repository** +1. Clone your new repository +1. Customize your image with `goldboot.json`