diff --git a/README.md b/README.md index c5fb25e8..b70d12e3 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,24 @@ It is aiming to reduce the number of these comments :) > This was fixed in #18. Can we release that fix? +## Badge + +Show that your project uses pkg.pr.new by adding a badge to your README: + +[![pkg.pr.new](https://pkg.pr.new/badge/stackblitz-labs/pkg.pr.new)](https://pkg.pr.new/~/stackblitz-labs/pkg.pr.new) + +### How to Get a Badge for Your Repository + +1. **Automatically on Repository Page**: + Visit your repository page at `https://pkg.pr.new/~/OWNER/REPO` and you'll find a badge with a copy button that will copy the markdown code for you. + +2. **Direct Badge URL**: + Use this format to create a badge for your repository: + ```markdown + [![pkg.pr.new](https://pkg.pr.new/badge/OWNER/REPO)](https://pkg.pr.new/~/OWNER/REPO) + ``` + Just replace `OWNER` and `REPO` with your GitHub username/organization and repository name. + These are some of the projects and companies using pkg.pr.new:

diff --git a/packages/app/app/components/BadgeGenerator.vue b/packages/app/app/components/BadgeGenerator.vue new file mode 100644 index 00000000..b8c3dc2d --- /dev/null +++ b/packages/app/app/components/BadgeGenerator.vue @@ -0,0 +1,58 @@ + + + diff --git a/packages/app/app/components/GettingStarted.vue b/packages/app/app/components/GettingStarted.vue index 61dbbed5..b5a6ff84 100644 --- a/packages/app/app/components/GettingStarted.vue +++ b/packages/app/app/components/GettingStarted.vue @@ -51,5 +51,32 @@ PR Screenshot + + +

Promote pkg.pr.new by adding a badge to your repository README:
+ +
+ +
+ +
+ Replace OWNER and REPO with your GitHub username/organization and + repository name. +
+ + + diff --git a/packages/app/app/pages/~/[owner]/[repo].vue b/packages/app/app/pages/~/[owner]/[repo].vue index 7034278d..c4e8018f 100644 --- a/packages/app/app/pages/~/[owner]/[repo].vue +++ b/packages/app/app/pages/~/[owner]/[repo].vue @@ -1,4 +1,6 @@