Skip to content

Commit d33a9de

Browse files
committed
Update README.md
closes #6
1 parent 343a711 commit d33a9de

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ You'll probably need to resolve merge conflicts after you do `git pull`.
1919

2020
2\. change `config.yaml`
2121

22-
3\. change `.gitignore`, unignore autogenerated files, see comments there
22+
3\. change `.gitignore`, unignore autogenerated files, see comments there.
23+
Specifically, you want to uncomment `index.html` from the `.gitignore`.
2324

2425
4\. make it:
2526

@@ -40,3 +41,14 @@ You'll probably need to resolve merge conflicts after you do `git pull`.
4041
~/your-org.github.io$ git commit src/db.json index.html -m 'rebuild'
4142
```
4243

44+
## Deployment Methods
45+
46+
There are two ways to deploy the badge board.
47+
The first is to deploy it at `https://<your-org>.github.io`.
48+
To do so, simply push your badgeboard to `https://github.com/<your-org>/<your-org>.github.io`.
49+
50+
The second way is to deploy it to a URL like `https://<your-org>.github.io/badgeboard`.
51+
You may prefer this method if you are already have a page for your GitHub organization.
52+
To do so, push your badgeboard to `https://github.com/<your-org>/badgeboard`
53+
and change the default branch to `gh-pages` instead of `master`.
54+
Of course, you don't have to name the repository `badgeboard` - you can name it whatever you'd like.

0 commit comments

Comments
 (0)