|
1 |
| -## Credits |
| 1 | +# Mobile App Minisite |
| 2 | +**Create and deploy a clean site for your iOS app in a couple of minutes.** |
| 3 | + |
| 4 | +Designed for GitHub Pages for super easy set up. Just fork this repo, edit _config.yml, upload screenshot/video and push the changes to the `gh-pages` branch. Voilá! Your site will become immediately viewable on your personal Github Pages account, e.g. `https://username.github.io/your-repos-name/` |
| 5 | + |
| 6 | +## Quick Start |
| 7 | + |
| 8 | +### Step 1: Fork this repo. |
| 9 | +After forking the repo, your site will often be live immediately on your personal Github Pages account, e.g. `https://yourusername.github.io/your-repos-name/` |
| 10 | + |
| 11 | +### Step 2: Edit `_config.yml` to customize for your app |
| 12 | +Once you have forked the repo, you can customize almost anything via the `_config.yml` file. To get started, enter your iOS app ID in the `ios_app_id` field. |
| 13 | + |
| 14 | +Things you can customise in `_config.yml`: |
| 15 | +- App Name |
| 16 | +- App Icon |
| 17 | +- App Description |
| 18 | +- App Price |
| 19 | +- App Store Link |
| 20 | +- Play Store Link |
| 21 | +- Press Kit Download Link |
| 22 | +- Header Image |
| 23 | +- Header Color |
| 24 | +- Background Color |
| 25 | +- Text Colors |
| 26 | +- iPhone Device Color |
| 27 | +- Your Name |
| 28 | +- Link to Website |
| 29 | +- Social Links and Contact Info |
| 30 | +- Feature List (Title, text, icon) |
| 31 | + |
| 32 | +### Step 3: Add screenshot or video |
| 33 | + |
| 34 | +#### Adding a screenshot |
| 35 | +Upload a `.png` or `.jpg` of your app to the folder `assets/screenshot/`. The name does not matter. The screenshot must have one of the following resolutions: |
| 36 | +- 828x1792 |
| 37 | +- 1125x2436 |
| 38 | +- 1242x2688. |
| 39 | + |
| 40 | +#### Adding video |
| 41 | +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. |
2 | 42 |
|
| 43 | +Video formats supported by Chrome and Firefox: |
| 44 | +- `.webm` |
| 45 | +- `.ogg` |
| 46 | + |
| 47 | +Video formats supported by Safari: |
| 48 | +- `.mp4` |
| 49 | +- `.mov` |
| 50 | + |
| 51 | +The videos must have one of the following resolutions: |
| 52 | +- 828x1792 |
| 53 | +- 1125x2436 |
| 54 | +- 1242x2688. |
| 55 | + |
| 56 | + |
| 57 | +## Feedback |
| 58 | +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. |
| 59 | + |
| 60 | +I'd love to see the sites you create using this little tool. |
| 61 | + |
| 62 | +## Credits |
3 | 63 | - [Jekyll](https://github.com/jekyll/jekyll)
|
4 | 64 | - [FontAwesome](https://fortawesome.github.io/Font-Awesome/)
|
5 | 65 |
|
6 | 66 | ## Author
|
7 |
| - |
8 | 67 | [Emil Baehr](https://emilbaehr.com/)
|
| 68 | +[Emil Baehr on Twitter](https://twitter.com/ebaehr) |
9 | 69 |
|
10 | 70 | ## License
|
11 |
| - |
12 | 71 | [MIT License](LICENSE)
|
0 commit comments