setup-git-repo 1.0.27 → 1.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +2 -2
  2. package/package.json +1 -1
  3. package/template/README.md +8 -7
  4. package/template/docs/BADGES.md +20 -3
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  <!-- template-git-repo:badges:start -->
2
2
  <p align="center">
3
3
  <a href="https://starterdocs.vtempest.workers.dev/docs/packages/setup-git-repo"><img src="https://img.shields.io/badge/Docs-blue?logo=ReadTheDocs&logoColor=white" alt="Documentation" /></a>
4
- <a href="https://stackblitz.com/github/OpenSourceAGI/dev-tools-starter-agent/tree/master/packages/setup-git-repo"><img height="20px" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" /></a>
5
4
  <br />
5
+ <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/stargazers"><img src="https://img.shields.io/github/stars/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Stars" /></a>
6
6
  <a href="https://www.npmjs.com/package/setup-git-repo"><img src="https://img.shields.io/npm/dm/setup-git-repo.svg" alt="NPM Monthly Downloads" /></a>
7
7
  <a href="https://www.npmjs.com/package/setup-git-repo"><img src="https://img.shields.io/npm/v/setup-git-repo.svg" alt="npm version" /></a>
8
8
  <a href="https://www.npmjs.com/package/setup-git-repo"><img src="https://img.shields.io/npm/dt/setup-git-repo.svg" alt="NPM Total Downloads" /></a>
@@ -10,13 +10,13 @@
10
10
  <a href="https://packagephobia.com/result?p=setup-git-repo"><img src="https://packagephobia.com/badge?p=setup-git-repo" alt="Install size" /></a>
11
11
  <a href="https://app.codecov.io/gh/OpenSourceAGI/dev-tools-starter-agent/flags"><img src="https://img.shields.io/codecov/c/github/OpenSourceAGI/dev-tools-starter-agent?flag=setup-git-repo&label=setup-git-repo%20coverage&logo=codecov&logoColor=white" alt="Coverage" /></a>
12
12
  <br />
13
- <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/stargazers"><img src="https://img.shields.io/github/stars/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Stars" /></a>
14
13
  <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/issues"><img src="https://img.shields.io/github/issues/OpenSourceAGI/dev-tools-starter-agent?logo=github" alt="GitHub Issues" /></a>
15
14
  <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/pulls"><img src="https://img.shields.io/github/issues-pr/OpenSourceAGI/dev-tools-starter-agent?logo=github&label=PRs" alt="Open Pull Requests" /></a>
16
15
  <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/OpenSourceAGI/dev-tools-starter-agent?logo=github&label=PRs%20merged&color=8957e5" alt="Merged Pull Requests" /></a>
17
16
  <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/discussions"><img src="https://img.shields.io/github/discussions/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Discussions" /></a>
18
17
  <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/commits/master/"><img src="https://img.shields.io/github/last-commit/OpenSourceAGI/dev-tools-starter-agent.svg" alt="GitHub last commit" /></a>
19
18
  <br />
19
+ <a href="https://stackblitz.com/github/OpenSourceAGI/dev-tools-starter-agent/tree/master/packages/setup-git-repo"><img height="20px" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" /></a>
20
20
  <img src="https://img.shields.io/badge/Bun-14151A?logo=bun&logoColor=white" alt="Bun" /> <img src="https://img.shields.io/badge/Vitest-6E9F18?logo=vitest&logoColor=white" alt="Vitest" />
21
21
  </p>
22
22
  <!-- template-git-repo:badges:end -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "setup-git-repo",
3
- "version": "1.0.27",
3
+ "version": "1.0.28",
4
4
  "description": "One command to set up a GitHub repo: Turborepo, CI workflows, README badges, and the docs for each",
5
5
  "type": "module",
6
6
  "bin": {
package/template/README.md CHANGED
@@ -5,19 +5,19 @@
5
5
  <!-- badge:docs --><a href="{{DOCS_URL}}"><img src="https://img.shields.io/badge/Docs-blue?logo=ReadTheDocs&logoColor=white" alt="Documentation" /></a>
6
6
  <!-- badge:api --><a href="{{API_URL}}"><img src="https://img.shields.io/badge/API-blue?logo=fastapi&logoColor=white" alt="API" /></a>
7
7
  <!-- badge:youtube --><a href="{{YOUTUBE_URL}}"><img height="20px" src="https://img.shields.io/badge/YouTube-red?style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube" /></a>
8
+ <!-- badge:uptime --><a href="https://stats.uptimerobot.com/{{UPTIME_ID}}"><img src="https://img.shields.io/badge/Uptime--Status-brightgreen?logo=uptimerobot&logoColor=white" alt="Uptime Status" /></a>
8
9
  <a href="https://deploy.workers.cloudflare.com/?url=https://github.com/{{OWNER}}/{{REPO}}"><img height="24px" src="https://deploy.workers.cloudflare.com/button" alt="Deploy to Cloudflare Workers" /></a>
9
- <a href="https://codespaces.new/{{OWNER}}/{{REPO}}"><img height="20px" src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces" /></a>
10
10
  <br />
11
- <!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/v/{{PACKAGE}}.svg" alt="npm version" /></a>
11
+ <a href="https://github.com/{{OWNER}}/{{REPO}}/stargazers"><img src="https://img.shields.io/github/stars/{{OWNER}}/{{REPO}}" alt="GitHub Stars" /></a>
12
12
  <!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/dm/{{PACKAGE}}.svg" alt="NPM Monthly Downloads" /></a>
13
+ <!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/v/{{PACKAGE}}.svg" alt="npm version" /></a>
13
14
  <!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/dt/{{PACKAGE}}.svg" alt="NPM Total Downloads" /></a>
15
+ <!-- badge:npm --><a href="https://packagephobia.com/result?p={{PACKAGE}}"><img src="https://packagephobia.com/badge?p={{PACKAGE}}" alt="Install size" /></a>
14
16
  <a href="https://codecov.io/gh/{{OWNER}}/{{REPO}}"><img src="https://codecov.io/gh/{{OWNER}}/{{REPO}}/graph/badge.svg" alt="Coverage" /></a>
15
17
  <a href="https://github.com/{{OWNER}}/{{REPO}}/actions/workflows/tests.yml"><img src="https://github.com/{{OWNER}}/{{REPO}}/actions/workflows/tests.yml/badge.svg?branch={{DEFAULT_BRANCH}}" alt="Tests" /></a>
16
- <!-- badge:uptime --><a href="https://stats.uptimerobot.com/{{UPTIME_ID}}"><img src="https://img.shields.io/badge/Uptime-Status-brightgreen?logo=uptimerobot&logoColor=white" alt="Uptime Status" /></a>
17
18
  <br />
18
- <a href="https://github.com/{{OWNER}}/{{REPO}}/stargazers"><img src="https://img.shields.io/github/stars/{{OWNER}}/{{REPO}}" alt="GitHub Stars" /></a>
19
- <a href="https://github.com/{{OWNER}}/{{REPO}}/forks"><img src="https://img.shields.io/github/forks/{{OWNER}}/{{REPO}}" alt="GitHub Forks" /></a>
20
19
  <a href="https://github.com/{{OWNER}}/{{REPO}}/graphs/contributors"><img src="https://img.shields.io/github/contributors/{{OWNER}}/{{REPO}}" alt="Contributors" /></a>
20
+ <a href="https://github.com/{{OWNER}}/{{REPO}}/forks"><img src="https://img.shields.io/github/forks/{{OWNER}}/{{REPO}}" alt="GitHub Forks" /></a>
21
21
  <a href="https://github.com/{{OWNER}}/{{REPO}}/issues"><img src="https://img.shields.io/github/issues/{{OWNER}}/{{REPO}}?logo=github" alt="GitHub Issues" /></a>
22
22
  <a href="https://github.com/{{OWNER}}/{{REPO}}/pulls"><img src="https://img.shields.io/github/issues-pr/{{OWNER}}/{{REPO}}?logo=github&label=PRs" alt="Open Pull Requests" /></a>
23
23
  <a href="https://github.com/{{OWNER}}/{{REPO}}/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/{{OWNER}}/{{REPO}}?logo=github&label=PRs%20merged&color=8957e5" alt="Merged Pull Requests" /></a>
@@ -25,9 +25,10 @@
25
25
  <a href="https://github.com/{{OWNER}}/{{REPO}}/graphs/contributors"><img src="https://img.shields.io/github/commit-activity/m/{{OWNER}}/{{REPO}}" alt="Commit Activity" /></a>
26
26
  <a href="https://github.com/{{OWNER}}/{{REPO}}/commits/{{DEFAULT_BRANCH}}/"><img src="https://img.shields.io/github/last-commit/{{OWNER}}/{{REPO}}.svg" alt="Last Commit" /></a>
27
27
  <!-- badge:discord --><a href="{{DISCORD_INVITE}}"><img src="https://img.shields.io/discord/{{DISCORD_ID}}.svg?label=Chat&logo=Discord&colorB=7289da&style=flat" alt="Join Discord" /></a>
28
- <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome" /></a>
29
- <a href="./LICENSE.md"><img src="https://img.shields.io/github/license/{{OWNER}}/{{REPO}}" alt="License" /></a>
30
28
  <br />
29
+ <a href="https://codespaces.new/{{OWNER}}/{{REPO}}"><img height="20px" src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces" /></a>
30
+ <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request"><img src="https://img.shields.io/badge/PRs--welcome-brightgreen" alt="PRs Welcome" /></a>
31
+ <a href="./LICENSE.md"><img src="https://img.shields.io/github/license/{{OWNER}}/{{REPO}}" alt="License" /></a>
31
32
  <img src="https://img.shields.io/badge/Claude-D97757?logo=claude&logoColor=fff" alt="Claude AI" />
32
33
  <img src="https://img.shields.io/badge/Cloudflare%20Workers-F38020?logo=cloudflareworkers&logoColor=white" alt="Cloudflare Workers" />
33
34
  <img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" alt="TypeScript" />
package/template/docs/BADGES.md CHANGED
@@ -334,9 +334,26 @@ markdown image syntax cannot center or set a height. Consequences:
334
334
  - GitHub's markdown renderer strips `style` attributes. Sizing has to come from
335
335
  the `height` attribute or from Shields' own `style=` parameter.
336
336
 
337
- Group by meaning, four rows: identity and links on row one, health and freshness
338
- on row two, community on row three, stack chips last. Four rows of five reads;
339
- twenty badges in one run is a wall.
337
+ Group by the question a reader is asking, four rows:
338
+
339
+ 1. **What this is and where to try it** — DOI, wiki, live app, docs, API, demo
340
+ video, uptime, the one-click deploy button.
341
+ 2. **Is anyone using it and does it work** — stars, npm downloads and version,
342
+ install size, coverage, CI.
343
+ 3. **Is it alive and who is behind it** — contributors, forks, issues, the PR
344
+ queue, commit activity, chat.
345
+ 4. **Run it yourself, and what it is built with** — Codespaces, StackBlitz, PRs
346
+ welcome, license, stack chips.
347
+
348
+ Row one earns the click, row two says whether the project is worth the click,
349
+ and the rest is for whoever is still reading. Four labelled rows read; twenty
350
+ badges in one run is a wall.
351
+
352
+ Two placements that look wrong and are not. Stars belong on row two with the
353
+ download counts — both answer "is anyone using this", while stars next to the
354
+ open-issue count read as project chatter. And the sandbox buttons belong at the
355
+ bottom rather than beside the live-app link, which is the one click row one is
356
+ there to earn.
340
357
 
341
358
  ## Verifying
342
359