Skip to content

Commit a414e14

Browse files
committed
Updates to readme.md
1 parent 388b78b commit a414e14

File tree

4 files changed

+82
-5
lines changed

4 files changed

+82
-5
lines changed

README.md

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,71 @@
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.
242

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
363
- [Jekyll](https://github.com/jekyll/jekyll)
464
- [FontAwesome](https://fortawesome.github.io/Font-Awesome/)
565

666
## Author
7-
867
[Emil Baehr](https://emilbaehr.com/)
68+
[Emil Baehr on Twitter](https://twitter.com/ebaehr)
969

1070
## License
11-
1271
[MIT License](LICENSE)

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ features :
4646

4747
- title : Video Support
4848
description : Preview app video on the iPhone device simply by placing your video files in the videos folder.
49-
fontawesome_icon_name : play
49+
fontawesome_icon_name : play-circle
5050

5151
- title : Automatic Icon and Metadata
5252
description : Enter iOS app ID in the _config.yml file to automatically fetch app icon, price and App Store Link.

_includes/head.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
<title>{{ site.app_name }}</title>
88
<meta name="description" content="{{ site.app_description }}">
99

10-
<!-- Favicon -->
1110
<link rel="shortcut icon" href="{{ site.app_icon }}">
1211

1312
<!-- Smart App Banner -->

_sass/layout.scss

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,25 @@ footer {
454454
display: flex;
455455
}
456456

457+
@media only screen and (max-width: 992px) {
458+
459+
.footerText {
460+
color: $footer-text-color;
461+
display: block;
462+
line-height: 1.5;
463+
width: 100%;
464+
text-align: center;
465+
padding-top: 54px;
466+
padding-bottom: 61px;
467+
}
468+
469+
.footerIcons {
470+
padding-bottom: 70px;
471+
display: flex;
472+
}
473+
474+
}
475+
457476
.hidden {
458477
display: none;
459478
}

0 commit comments

Comments
 (0)