Skip to content

Commit c001a7f

Browse files
Updated the readme.
1 parent 8d43c71 commit c001a7f

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
## Midnight
22

3-
Switches dynamically between multiple header designs, so it looks in line with the content below it.
3+
A jQuery plugin that switches between multiple header designs as you scroll, so you always have a header that looks great with the content below it.
44

5+
**[Check out the demo](http://aerolab.github.io/midnight.js/)** (watch the logo as you scroll).
56

67
## Quick start
78

@@ -114,3 +115,9 @@ $('nav').midnight({
114115
defaultClass: 'default'
115116
});
116117
```
118+
119+
## Known Issues
120+
121+
On iOS <7 and older Android devices scrollTop isn't updated fluently, which creates a choppy effect. It can be fixed somewhat by wrapping the body in container and detecting touch events, but we're leaving that as an open issue. We'll probably disable the effect on older mobile devices due to bad performance.
122+
123+
You shouldn't add any sort of padding, margin or offset (top/left/right/bottom) to the nav, since it causes issues with rendering.

index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<meta property="og:description" content="Midnight.js is a jQuery plugin that lets you sublty change your headers to make them match the content as you scroll." />
2020
<meta property="og:image" content="http://aerolab.github.io/midnight.js/assets/images/midnight-facebook.png" />
2121
<meta property="og:url" content="http://aerolab.github.io/midnight.js" />
22-
<meta property="fb:app_id" content="" />
22+
<meta property="fb:app_id" content="344819049029949" />
2323

2424
<!-- Twitter Stuff -->
2525
<meta property="twitter:card" content="summary" />
@@ -67,8 +67,8 @@
6767

6868

6969
<div class="top-links" data-midnight="white">
70-
<a class="button" href="https://aerolab.github.io/midnight.js/midnight.jquery.js">Download</a>
71-
<a class="button button-github" href="https://aerolab.github.io/midnight.js">Fork on GitHub</a>
70+
<a class="button" href="https://aerolab.github.io/midnight.js/midnight.jquery.js" download>Download</a>
71+
<a class="button button-github" href="https://github.com/Aerolab/midnight.js" target="_blank">Fork on GitHub</a>
7272
</div>
7373

7474

@@ -224,8 +224,8 @@ <h2>Further customization</h2>
224224

225225
<div class="container">
226226
<div class="buttons wow fadeIn">
227-
<a class="button" href="https://aerolab.github.io/midnight.js/midnight.jquery.js">Download</a>
228-
<a class="button" href="https://aerolab.github.io/midnight.js"><i class="icon-github"></i> Fork on GitHub</a>
227+
<a class="button" href="https://aerolab.github.io/midnight.js/midnight.jquery.js" download>Download</a>
228+
<a class="button" href="https://github.com/Aerolab/midnight.js" target="_blank"><i class="icon-github"></i> Fork on GitHub</a>
229229
</div>
230230
</div>
231231

0 commit comments

Comments
 (0)