From d90a066118eeaaca71f6d666de62bf6414b67a50 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Sat, 25 Jun 2022 06:31:00 -0400 Subject: [PATCH] Update README.md --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/README.md b/README.md index 13f9163..b5d8cb2 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ # AstroWind + +A basic template to make your website using Astro + Tailwind CSS. + +> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside AstroWind template, you'll see the following folders and files: + +``` +/ +├── public/ +│ ├── robots.txt +│ └── favicon.ico +├── src/ +│ ├── components/ +│ │ ├── astro/ +| | | ├── headers/ +| | | ├── footers/ +| | | ├── heros/ +| | | └── ... +| | ├── react/ +| | └── ... +│ ├── layouts/ +│ | └── Layout.astro +│ └── pages/ +│ └── index.astro +└── package.json +``` + +Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. + +There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. + +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:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).