Skip to content

Commit 30d3f31

Browse files
committed
readme
1 parent 288a680 commit 30d3f31

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[![pkg.pr.new](https://d4a1abd4.stackblitz-cr.pages.dev/badge/stackblitz-labs/pkg.pr.new)](https://pkg.pr.new/~/stackblitz-labs/pkg.pr.new)
2-
31
<p align="center"><img src="https://github.com/user-attachments/assets/314d5112-f67f-4758-82bf-7b0c19c01ba6" /></p>
42

53
# pkg.pr.new <span><img src="https://emoji.slack-edge.com/TFHDVN56F/stackblitz/fd010078dcccebca.png" width="30" /></span>
@@ -28,6 +26,24 @@ It is aiming to reduce the number of these comments :)
2826

2927
> This was fixed in #18. Can we release that fix?
3028
29+
## Badge
30+
31+
Show that your project uses pkg.pr.new by adding a badge to your README:
32+
33+
[![pkg.pr.new](https://pkg.pr.new/badge/stackblitz-labs/pkg.pr.new)](https://pkg.pr.new/~/stackblitz-labs/pkg.pr.new)
34+
35+
### How to Get a Badge for Your Repository
36+
37+
1. **Automatically on Repository Page**:
38+
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.
39+
40+
2. **Direct Badge URL**:
41+
Use this format to create a badge for your repository:
42+
```markdown
43+
[![pkg.pr.new](https://pkg.pr.new/badge/OWNER/REPO)](https://pkg.pr.new/~/OWNER/REPO)
44+
```
45+
Just replace `OWNER` and `REPO` with your GitHub username/organization and repository name.
46+
3147
These are some of the projects and companies using pkg.pr.new:
3248

3349
<p align="center">

0 commit comments

Comments
 (0)