Skip to content

Commit ff32857

Browse files
committed
docs: update README with new Quick Start instructions
1 parent a62bcea commit ff32857

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,30 @@
1919

2020
## 🔥 Quick Start
2121

22-
This repository is meant to be used as a template for new projects.
22+
The fastest way to bootstrap a new project from this template is to run the following command in your terminal:
23+
24+
```bash
25+
curl -fsSL https://raw.githubusercontent.com/apiad/starter/main/install.sh | bash
26+
```
27+
28+
This interactive script will:
29+
1. **Prompt** for your project name and target directory.
30+
2. **Clone** the template and **reset** the Git history.
31+
3. **Clean** out placeholder content (`README.md`, `CHANGELOG.md`, `journal/`, etc.).
32+
4. **Initialize** a fresh project structure, ready for the Gemini CLI.
33+
5. **Launch** the Gemini CLI to start your first session.
34+
35+
Once Gemini CLI is open, run `/scaffold` to begin, or `/onboard` to get an overview of the repository.
36+
37+
---
38+
39+
## 🏗️ Alternative Installation
40+
41+
If you prefer a manual setup:
2342

2443
1. Clone the repo or [create a new project directly](https://github.com/apiad/starter/generate).
2544
2. Delete `README.md`, `CHANGELOG.md`, and `journal/*.md` to get a fresh history.
2645
3. Run `gemini /scaffold` to start a new project.
27-
4. Follow instructions and enjoy!
2846

2947
## 🧠 The Core Philosophy
3048

0 commit comments

Comments
 (0)