Skip to content

Commit 2df5acb

Browse files
committed
chore: add badges instructions to the README
1 parent 05dfbee commit 2df5acb

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,21 @@ Then push some code to main:
5252
git push -u origin main
5353
```
5454

55+
1. Create the `badges` branch for storing the README coverage badge.
56+
57+
```bash
58+
git checkout --orphan badges
59+
git rm -rf .
60+
rm -f .gitignore
61+
echo 'This branch exists only to contains the coverage badge in the README on `main`.' > README.md
62+
git add README.md
63+
git commit -m 'chore: initialize the badges branch'
64+
git push origin badges
65+
```
66+
5567
Then customize the code for your repository:
5668

57-
1. Check out a new branch to set up the repo `git checkout -b setup`
69+
1. Check out a new branch to set up the repo `git checkout -b setup main`
5870

5971
1. Update the code for your project:
6072

0 commit comments

Comments
 (0)