search

bjork24 / Unison

Unifying named breakpoints across CSS, JS, and HTML
http://bjork24.github.io/Unison
MIT License
453 stars 41 forks source link

Documentation improvement #4

Closed cmegown closed 10 years ago

cmegown commented 10 years ago

Nothing big, but could clear up some confusion folks might have.

In the "How does it work" section you create the breakpoint variables, add them into the $mq-sync list, add the script, and call it done. In reality, that's not all it takes to get this working though because you mention in the next section "Behind the scenes" that there's a breakpoint file where the media queries are generated and some information is saved into the head.

Without reading that part, which comes after things are said to be working, or looking into the repo and looking through breakpoints files it's pretty easy to get lost along the way.

I'd make a pull request of it if the HTML was available in the repo, but it's a pretty small fix anyway. Great job though, looks like a tool with some really interesting possibilities!

bjork24 commented 10 years ago

Good point. Will add more clarification of what's happening.