Skip to content

Commit 12d8ea8

Browse files
committed
Updates to README
1 parent 9cf3df8 commit 12d8ea8

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,17 @@ Designed for GitHub Pages for super easy set up.
1111

1212
🎨 Customise site in `_config.yml` (no HTML/CSS)
1313

14+
📝 Write Privacy Policy as markdown in `privacypolicy.md`
15+
16+
🕒 Keep a changelog in `CHANGELOG.md`
17+
1418
✅ Site becomes live at GitHub Pages repository URL, e.g. `https://your-username.github.io/your-repo-name/`.
1519

1620
<img src="https://emilbaehr.com/files/jayson1.png" width="440"> <img src="https://emilbaehr.com/files/slor1.png" width="440">
1721

22+
23+
24+
1825
## Quick Start
1926

2027
### Step 1: Fork this repo.
@@ -51,13 +58,9 @@ Things you can customise in `_config.yml`:
5158

5259
### Step 3: Add screenshot or video
5360

54-
55-
5661
#### Adding a screenshot
5762
Upload a `.png` or `.jpg` of your app to the folder `assets/screenshot/`. The name does not matter. Be sure to delete the placeholder `yourscreenshot.png`.
5863

59-
60-
6164
#### Adding video
6265
Upload your video to the folder `assets/videos/`. To have support for most browsers, you need to upload two files – one for Safari and one for Chrome/Firefox.
6366

@@ -69,8 +72,6 @@ Video formats supported by Safari:
6972
- `.mp4`
7073
- `.mov`
7174

72-
73-
7475
#### Resolutions
7576
The videos and screenshots must have one of the following resolutions:
7677
- 828x1792
@@ -79,27 +80,34 @@ The videos and screenshots must have one of the following resolutions:
7980

8081

8182

83+
### Step 4: Edit (or remove) Privacy Policy and Changelog
84+
Your site automatically includes pages for a Privacy Policy and a Changelog. Change the content of these pages by editing the `privacypolicy.md` and `CHANGELOG.md` files in the `_pages` directory.
85+
86+
In each of the markdown files, you can set the `include_in_header:` value to either `true` or `false`. This determines if the page is included in the top navigation.
87+
By default, only the Changelog is included in the top navigation. The title of the navigation item can also be edited, by editing the `title:` in each markdown file.
88+
89+
If you need to, you can create additional markdown based pages just by creating an `.md` file like the `privacypolicy.md` and `CHANGELOG.md` files in the `_pages` directory.
90+
91+
**Please note:** The Privacy Policy and Changelog provided are written using dummy text, so please adapt each of them for your own app.
92+
You can also choose not to include these pages, by simple deleting the `privacypolicy.md` and `CHANGELOG.md` files.
93+
94+
95+
96+
8297
## Feedback
8398
If you have feedback regarding bugs or improvements, open an issue, @ me on Twitter or write me an email. You can find my contact info on my website.
8499

85100
I'd love to see the sites you create using this little tool.
86101

87-
88-
89102
## Credits
90103
- [Jekyll](https://github.com/jekyll/jekyll)
91104
- [FontAwesome](https://fortawesome.github.io/Font-Awesome/)
92105

93-
94-
95106
## Donations
96107
[Donations are welcome](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=S8ZZT3JXJPN92&currency_code=USD&source=url)
97108

98-
99109
## Author
100110
[Emil Baehr](https://emilbaehr.com/)
101111

102-
103-
104112
## License
105113
[MIT License](LICENSE)

0 commit comments

Comments
 (0)