Skip to content

Commit 5dce2c9

Browse files
committed
docs: update README, TASKS, and CHANGELOG for unified installer
1 parent 679f4cc commit 5dce2c9

4 files changed

Lines changed: 28 additions & 25 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.11.0] - 2026-03-11
9+
10+
### Added
11+
- Unified `install.sh` script that handles both initial project bootstrapping and non-destructive framework updates/integrations in existing repositories.
12+
- Automatic git environment validation (clean tree requirement) and post-install commits to `install.sh`.
13+
- Interactive summary and confirmation of proposed changes (created vs. updated files) in the installer.
14+
15+
### Removed
16+
- `add-gemini.sh` script (its logic is now integrated into the unified `install.sh`).
17+
18+
### Changed
19+
- Streamlined `README.md` with a single, unified "Quick Start" command for all use cases.
20+
821
## [0.10.1] - 2026-03-03
922

1023
### Changed

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,28 @@
1919

2020
## 🔥 Quick Start
2121

22-
The fastest way to bootstrap a new project from this template is to run the following command in your terminal:
22+
The fastest way to bootstrap a new project or integrate the framework into an existing one is to run the following command in your terminal:
2323

2424
```bash
2525
curl -fsSL https://raw.githubusercontent.com/apiad/starter/main/install.sh | bash
2626
```
2727

2828
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.
29+
1. **Validate** your environment (requires `git`, `node`, and a clean working tree).
30+
2. **Clone** the latest framework components to a temporary location.
31+
3. **Analyze** your current directory and propose a list of files to create or update.
32+
4. **Prompt** for your explicit confirmation before applying any changes.
33+
5. **Integrate** the `.gemini/` configuration and framework files (non-destructively).
34+
6. **Commit** the changes automatically with a descriptive message.
3435

35-
Once Gemini CLI is open, run `/scaffold` to begin, or `/onboard` to get an overview of the repository.
36+
Once the installation is complete, run `gemini /onboard` to get an overview of the repository and start your first session.
3637

37-
### 📥 Integration (Existing Projects)
38-
39-
To add this framework to an existing Git repository, run:
40-
41-
```bash
42-
curl -fsSL https://raw.githubusercontent.com/apiad/starter/main/add-gemini.sh | bash
43-
```
44-
45-
This script will:
46-
1. **Check** for a clean working tree.
47-
2. **Prompt** for permission before overwriting any existing core files.
48-
3. **Extract** the `.gemini/` configuration and framework files.
49-
4. **Create** a first integration commit.
50-
51-
### 🏗️ Alternative Installation
38+
### 🏗️ Alternative: Manual Setup
5239

5340
If you prefer a manual setup:
5441

55-
1. Clone the repo or [create a new project directly](https://github.com/apiad/starter/generate).
56-
2. Delete `README.md`, `CHANGELOG.md`, and `journal/*.md` to get a fresh history.
57-
3. Run `gemini /scaffold` to start a new project.
42+
1. [Create a new project from this template](https://github.com/apiad/starter/generate).
43+
2. Follow the onboarding instructions in the generated repository.
5844

5945
---
6046

TASKS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Put done tasks into the Archive.
1919
---
2020

2121
## Archive
22+
- [x] Consolidate `add-gemini.sh` into a unified, non-destructive `install.sh` for setup and updates. (2026-03-11) (See plan: plans/unified-installer.md)
2223
- [x] Implement the `install.sh` scaffolding script for new projects. (2026-03-03) (See plan: plans/install-script-scaffolding.md)
2324
- [x] Refactor the `/research` command to follow a more extensible, executive-style reporting workflow with iterative updates and asset linking. (2026-03-02)
2425
- [x] Implement drafting (`/draft`) and editing (`/revise`) capabilities using specialized subagents. (2026-03-02) (See plan: plans/drafting-and-editing-capabilities.md)

journal/2026-03-11.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 2026-03-11
2+
3+
- Consolidated `add-gemini.sh` into a unified, non-destructive `install.sh` for project setup and framework updates.

0 commit comments

Comments
 (0)