From 1193319e37b11d782aa14c90d777391166230ec7 Mon Sep 17 00:00:00 2001 From: Chris Williams Date: Mon, 6 May 2024 13:53:46 +0100 Subject: [PATCH] add update section --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index afef1190b..03d3d9f79 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,14 @@ Astro Cactus is a simple opinionated starter built with the Astro framework. Use 4. [Preview](#preview) 5. [Commands](#commands) 6. [Configure](#configure) -7. [Adding Posts](#adding-posts) +7. [Updating](#updating) +8. [Adding Posts](#adding-posts) - [Frontmatter](#frontmatter) - [Frontmatter Snippet](#frontmatter-snippet) -8. [Pagefind search](#pagefind-search) -9. [Analytics](#analytics) -10. [Deploy](#deploy) -11. [Acknowledgment](#acknowledgment) +9. [Pagefind search](#pagefind-search) +10. [Analytics](#analytics) +11. [Deploy](#deploy) +12. [Acknowledgment](#acknowledgment) ## Key Features @@ -98,6 +99,12 @@ Replace pnpm with your choice of npm / yarn - Optional: - Fonts: This theme sets the body element to the font family `font-mono`, located in the global css file `src/styles/global.css`. You can change fonts by removing the variant `font-mono`, after which TailwindCSS will default to the `font-sans` [font family stack](https://tailwindcss.com/docs/font-family). +## Updating + +If you've forked the template, you can [sync the fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) with your own project, remembering to not click Discard Changes as you will lose your own. + +If you have a template repository, you can add this template as a remote, as discussed [here](https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository). + ## Adding posts This theme utilises [Content Collections](https://docs.astro.build/en/guides/content-collections/) to organise Markdown and/or MDX files, as well as type-checking frontmatter with a schema -> `src/content/config.ts`.