Skip to content

Commit 317dc13

Browse files
committed
docs: update README
1 parent 18f91dc commit 317dc13

1 file changed

Lines changed: 31 additions & 33 deletions

File tree

README.md

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,41 @@
1-
# Astro Starter Kit: Minimal
1+
# rustkit-ai.github.io
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
6-
7-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
8-
9-
## 🚀 Project Structure
10-
11-
Inside of your Astro project, you'll see the following folders and files:
3+
Organization website for [rustkit-ai](https://github.com/rustkit-ai) — built with [Astro](https://astro.build), deployed on GitHub Pages.
124

13-
```text
14-
/
15-
├── public/
16-
├── src/
17-
│ └── pages/
18-
│ └── index.astro
19-
└── package.json
20-
```
5+
Live: **https://rustkit-ai.github.io**
216

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.
7+
## Stack
238

24-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
9+
- [Astro](https://astro.build) — static site generator
10+
- Pure CSS — no UI framework
11+
- GitHub Actions — automatic deployment on push to `main`
12+
- GitHub API — stars fetched at build time
2513

26-
Any static assets, like images, can be placed in the `public/` directory.
14+
## Project structure
2715

28-
## 🧞 Commands
16+
```
17+
src/
18+
├── components/
19+
│ ├── Nav.astro
20+
│ ├── Hero.astro
21+
│ ├── Projects.astro # fetches GitHub stars at build time
22+
│ ├── Philosophy.astro
23+
│ ├── Founders.astro
24+
│ └── Footer.astro
25+
├── layouts/Layout.astro
26+
├── pages/index.astro
27+
└── styles/global.css
28+
```
2929

30-
All commands are run from the root of the project, from a terminal:
30+
## Dev
3131

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 |
32+
```sh
33+
npm install
34+
npm run dev # http://localhost:4321
35+
npm run build # build to ./dist
36+
npm run preview # preview the build
37+
```
4038

41-
## 👀 Want to learn more?
39+
## Deployment
4240

43-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
41+
Automatically deployed via GitHub Actions on every push to `main`.

0 commit comments

Comments
 (0)