Skip to content

Commit 014fa8f

Browse files
committed
chore: update README with project description, tech stack, and license information
1 parent 47d115f commit 014fa8f

File tree

1 file changed

+16
-35
lines changed

1 file changed

+16
-35
lines changed

README.md

Lines changed: 16 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,24 @@
1-
# Astro Starter Kit: Minimal
1+
# satna.ing
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
3+
A fully custom link hub designed and built from scratch.
64

7-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
5+
https://github.com/user-attachments/assets/25bc62ef-1c24-49dd-955d-83a4454f9502
86

9-
## 🚀 Project Structure
7+
[![Netlify Status](https://api.netlify.com/api/v1/badges/c9c2f3d5-8e65-4511-bc75-6e9c15655916/deploy-status)](https://app.netlify.com/projects/satna-ing/deploys)
8+
[![Astro](https://img.shields.io/badge/Astro-5.14-FF5D01?logo=astro)](https://astro.build)
9+
[![Tailwind CSS](https://img.shields.io/badge/Tailwind-4.1-38B2AC?logo=tailwind-css)](https://tailwindcss.com)
10+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-3178C6?logo=typescript)](https://www.typescriptlang.org)
11+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1012

11-
Inside of your Astro project, you'll see the following folders and files:
13+
> Designed and built with ❤️ by [Sat Naing](https://satna.ing)
1214
13-
```text
14-
/
15-
├── public/
16-
├── src/
17-
│ └── pages/
18-
│ └── index.astro
19-
└── package.json
20-
```
15+
## 🛠️ Tech Stack
2116

22-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
17+
- **[Astro 5](https://astro.build)** — Static site generation with zero JS by default
18+
- **[Tailwind CSS 4](https://tailwindcss.com)** — Modern utility-first CSS
19+
- **[TypeScript](https://www.typescriptlang.org)** — Type safety throughout
20+
- **[Partytown](https://partytown.builder.io)** — Web worker for third-party scripts
2321

24-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
22+
## 📄 License
2523

26-
Any static assets, like images, can be placed in the `public/` directory.
27-
28-
## 🧞 Commands
29-
30-
All commands are run from the root of the project, from a terminal:
31-
32-
| Command | Action |
33-
| :------------------------ | :----------------------------------------------- |
34-
| `npm install` | Installs dependencies |
35-
| `npm run dev` | Starts local dev server at `localhost:4321` |
36-
| `npm run build` | Build your production site to `./dist/` |
37-
| `npm run preview` | Preview your build locally, before deploying |
38-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
39-
| `npm run astro -- --help` | Get help using the Astro CLI |
40-
41-
## 👀 Want to learn more?
42-
43-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
24+
This project is open source and available under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)