diff --git a/README.md b/README.md index 414a13a..c373370 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,26 @@ -# Astro Starter Kit: Basics +# Personal Site + +A minimal personal blog built with Astro and Tailwind CSS. + +## Development ```sh -npm create astro@latest -- --template basics +npm install +npm run dev ``` -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +## Commands -## 🚀 Project Structure +| Command | Action | +| :---------------- | :------------------------------------------ | +| `npm install` | Install dependencies | +| `npm run dev` | Start dev server at `localhost:4321` | +| `npm run build` | Build production site to `./dist/` | +| `npm run preview` | Preview production build locally | +| `npm run format` | Format code with Prettier | -Inside of your Astro project, you'll see the following folders and files: +## Tech Stack -```text -/ -├── public/ -│ └── favicon.svg -├── src -│   ├── assets -│   │   └── astro.svg -│   ├── components -│   │   └── Welcome.astro -│   ├── layouts -│   │   └── Layout.astro -│   └── pages -│   └── index.astro -└── package.json -``` - -To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). - -## 🧞 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). +- [Astro](https://astro.build) - Static site framework +- [Tailwind CSS](https://tailwindcss.com) - Styling +- Content collections for blog posts