summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2025-05-23 14:52:33 +0200
committerYuval Adam <_@yuv.al>2025-05-23 14:52:33 +0200
commitb400b4fb81b656ec53208c43185ed7887769acc1 (patch)
tree5d782171278f70b25bc10f482bc09d414e5b5699
parent3386dfab4ed49ecd00678e2635449f9ba41156d5 (diff)
Update readme
-rw-r--r--README.md53
1 files changed, 10 insertions, 43 deletions
diff --git a/README.md b/README.md
index e34a99b..649dd07 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,14 @@
-# Astro Starter Kit: Minimal
+# Astro Base
-```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!
-
-## 🚀 Project Structure
-
-Inside of your Astro project, you'll see the following folders and files:
-
-```text
-/
-├── public/
-├── src/
-│ └── pages/
-│ └── index.astro
-└── package.json
-```
+A minimal template for new Astro projects. Includes
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+- TypeScript
+- Tailwind CSS
+- React
+- Tailwind Typography
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+## Start a New Project
-Any static assets, like images, can be placed in the `public/` directory.
-
-## 🧞 Commands
-
-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).
+```sh
+$ npm create astro@latest new-project -- --template yuvadm/astro-base
+``` \ No newline at end of file