Skip to content

Commit 6b6efe0

Browse files
authored
docs: add README (#2)
1 parent 30db151 commit 6b6efe0

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# rnrcli.io
2+
3+
[![Build](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/rnrcli.io/build.yml?style=for-the-badge)](https://github.com/CodingWithCalvin/rnrcli.io/actions)
4+
[![License](https://img.shields.io/github/license/CodingWithCalvin/rnrcli.io?style=for-the-badge)](LICENSE)
5+
6+
The website for [rnr](https://github.com/CodingWithCalvin/rnr.cli), a cross-platform task runner with zero-setup execution.
7+
8+
## Tech Stack
9+
10+
- [Astro](https://astro.build/) - Static site generator
11+
- [Tailwind CSS](https://tailwindcss.com/) - Styling
12+
- [Cloudflare Workers](https://workers.cloudflare.com/) - Hosting
13+
14+
## Development
15+
16+
```bash
17+
npm install
18+
npm run dev
19+
```
20+
21+
## Build
22+
23+
```bash
24+
npm run build
25+
```
26+
27+
## Project Structure
28+
29+
```
30+
src/
31+
├── components/ # Reusable Astro components
32+
├── content/docs/ # Documentation markdown files
33+
├── layouts/ # Page layouts
34+
├── pages/ # Site pages
35+
└── styles/ # Global styles
36+
public/ # Static assets
37+
```

0 commit comments

Comments
 (0)