Skip to content

Commit 45b7d05

Browse files
committed
feat: improve setup README with card display, snippet, and clearer description
1 parent 9fda1d9 commit 45b7d05

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

src/cli/commands/setup/workflows.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ describe("buildReadme", () => {
5757
expect(readme).toMatch(/^# Dev Pulse/);
5858
});
5959

60-
it("includes username with link", () => {
60+
it("includes github-weekly-reporter link", () => {
6161
const readme = buildReadme(baseOpts);
62-
expect(readme).toContain("[@testuser](https://github.com/testuser)");
62+
expect(readme).toContain("[github-weekly-reporter](https://github.com/deariary/github-weekly-reporter)");
6363
});
6464

6565
it("includes pages URL", () => {

src/cli/commands/setup/workflows.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,14 +186,24 @@ export const buildReadme = (opts: {
186186
const displayTitle = opts.siteTitle.replace(/\\n/g, " ");
187187
return `# ${displayTitle}
188188
189-
Weekly GitHub activity reports for [@${opts.username}](https://github.com/${opts.username}), powered by [github-weekly-reporter](https://github.com/deariary/github-weekly-reporter).
189+
This repository is generated and updated by [github-weekly-reporter](https://github.com/deariary/github-weekly-reporter).
190+
191+
Every week, GitHub Actions collects my activity (commits, PRs, reviews), an LLM writes a narrative summary, and the result is published as a blog-style report page and an animated profile card.
190192
191193
## Live Reports
192194
193195
${opts.pagesUrl}
194196
195197
## Profile Card
196198
199+
<a href="https://github.com/${opts.repo}">
200+
<picture>
201+
<source media="(prefers-color-scheme: dark)" srcset="${opts.pagesUrl}/card-dark.svg" />
202+
<source media="(prefers-color-scheme: light)" srcset="${opts.pagesUrl}/card.svg" />
203+
<img alt="Weekly Report" src="${opts.pagesUrl}/card.svg" />
204+
</picture>
205+
</a>
206+
197207
Add this to your [GitHub Profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme):
198208
199209
\`\`\`html

0 commit comments

Comments
 (0)