From bcd051569a05e85279c1b5c0a191bb4b7b346f28 Mon Sep 17 00:00:00 2001 From: Paul Scanlon Date: Thu, 8 Aug 2024 10:42:24 +0100 Subject: [PATCH] chore: update README --- README.md | 50 +++++++++++--------------------------------------- 1 file changed, 11 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index e34a99b..4a9b4c8 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,19 @@ -# Astro Starter Kit: Minimal +# ... -```sh -npm create astro@latest -- --template minimal -``` - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json) - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +This repository contains all the code referenced in the following blog post: -## 🚀 Project Structure +- [...](...) -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json -``` +To use this code you'll need two environment variables provided by [Luzmo](https://www.luzmo.com/). The steps for how to create them are covered in the blog post. -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +## Environment variables -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +Rename `.env.example` to `.env` and follow the steps in the above mentioned blog post. -Any static assets, like images, can be placed in the `public/` directory. +## Install dependencies -## 🧞 Commands +This repository uses `npm`. -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | - -## 👀 Want to learn more? - -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +```shell +npm install +```