Skip to content

Commit 659d267

Browse files
Merge pull request #51 from DeDuckProject/claude/add-readme-getting-started-qM7QJ
Improve git-glimpse onboarding with AI agent prompt and tips
2 parents 249b139 + 9b8dc95 commit 659d267

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ PR opened/updated (or /glimpse comment)
2828

2929
## Quick start
3030

31+
> **One-prompt integration:** Paste this into your AI agent (Cursor, Copilot, Claude Code, etc.):
32+
> ```
33+
> Integrate git-glimpse into this repo: https://github.com/DeDuckProject/git-glimpse. Follow the README instructions.
34+
> ```
35+
> See [an example integration PR](https://github.com/DeDuckProject/epp-demo/pull/41) to know what to expect.
36+
3137
### 1. Add the workflow files
3238
3339
Two files are recommended. The first is the main pipeline; the second gives instant 👀 feedback on `/glimpse` comments without adding noise to PR push checks.
@@ -140,6 +146,8 @@ export default {
140146
} satisfies GitGlimpseConfig;
141147
```
142148

149+
> **Tip:** Keep the default `auto` mode for your first PR — it runs automatically so you'll see the demo right away. Once you've confirmed everything works, you can switch to `on-demand` if you prefer. Starting with `on-demand` means no demo on your first PR, so you won't know if the integration is working.
150+
143151
### 3. Add secrets
144152

145153
In your repo: **Settings → Secrets and variables → Actions**

0 commit comments

Comments
 (0)