diff --git a/README.md b/README.md new file mode 100644 index 0000000..902dc7e --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# rnrcli.io + +[![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) +[![License](https://img.shields.io/github/license/CodingWithCalvin/rnrcli.io?style=for-the-badge)](LICENSE) + +The website for [rnr](https://github.com/CodingWithCalvin/rnr.cli), a cross-platform task runner with zero-setup execution. + +## Tech Stack + +- [Astro](https://astro.build/) - Static site generator +- [Tailwind CSS](https://tailwindcss.com/) - Styling +- [Cloudflare Workers](https://workers.cloudflare.com/) - Hosting + +## Development + +```bash +npm install +npm run dev +``` + +## Build + +```bash +npm run build +``` + +## Project Structure + +``` +src/ +├── components/ # Reusable Astro components +├── content/docs/ # Documentation markdown files +├── layouts/ # Page layouts +├── pages/ # Site pages +└── styles/ # Global styles +public/ # Static assets +```