-
Notifications
You must be signed in to change notification settings - Fork 142
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,35 @@ | ||
| # Breakpoint [](http:https://badge.fury.io/rb/breakpoint) [](https://travis-ci.org/Team-Sass/breakpoint) | ||
| # Breakpoint [npm version](https://badge.fury.io/js/breakpoint-sass.svg)   | ||
|
|
||
|
|
||
|
|
||
| **Really Simple Media Queries with Sass** | ||
|
|
||
| Breakpoint makes writing media queries in Sass super simple. Create a variable using a simplified syntax based on most commonly used media queries, then call it using the `breakpoint` mixin. Breakpoint handles all of the heavy lifting, from writing the media query itself, to handling cross-browser compatibility issues, so you can focus on what's important: making sure your website looks its best. | ||
|
|
||
| Breakpoint also allows you to get the [context of your media queries](https://github.com/Team-Sass/breakpoint/wiki/Breakpoint-Context) from your code, allowing you to write dynamic mixins based on their media query context. | ||
| Breakpoint also allows you to get the [context of your media queries](https://github.com/at-import/breakpoint/wiki/Breakpoint-Context) from your code, allowing you to write dynamic mixins based on their media query context. | ||
|
|
||
| If you'd prefer the semantic awesomeness of string names to identify your queries as opposed to variables, or want to dynamically generate media queries, the [Respond-To](https://github.com/Team-Sass/breakpoint/wiki/Respond-To) syntax is now included in Breakpoint core! | ||
| If you'd prefer the semantic awesomeness of string names to identify your queries as opposed to variables, or want to dynamically generate media queries, the [Respond-To](https://github.com/at-import/breakpoint/wiki/Respond-To) syntax is now included in Breakpoint core! | ||
|
|
||
| **It is important to note** that due to limitations within the Sass language itself, which themselves stem from some potentially unexpected cascading from doing so, Breakpoint is unable to concat like media queries into a single media query. This means they will be spread out throughout your CSS. This is unfortunate, yes, but currently unavoidable. That being said, once [Sass Issue #241: Seperate Media/Browser Specific Markup to Separate Style Sheet](https://github.com/nex3/sass/issues/241) hits, be sure we're going to take full advantage of it. | ||
|
|
||
|
|
||
| ## Full documentation is available on the [Breakpoint Wiki](https://github.com/Team-Sass/breakpoint/wiki) | ||
| ## Full documentation is available on the [Breakpoint Wiki](https://github.com/at-import/breakpoint/wiki) | ||
|
|
||
| ## Getting Help with Breakpoint | ||
|
|
||
| * For help with Breakpoint, please ask a question on [Stack Overflow](http:https://stackoverflow.com/questions/ask) tagged with "breakpoint-sass". | ||
| * To file an issue with Breakpoint, be it a feature request or a bug report, please use our [Issue Queue](https://github.com/Team-Sass/breakpoint/issues). | ||
| * To file an issue with Breakpoint, be it a feature request or a bug report, please use our [Issue Queue](https://github.com/at-import/breakpoint/issues). | ||
| * **Each Separate Bug Report or Feature Request Must Have Its Own Issue** | ||
| * Search in both active issues and closed issues before filing your own. If one already exists, please respond there. | ||
| * If you are in IRC, the maintainers and many fellow users tend to hang out in the #sass and #compass rooms on irc.freenode.net. Asking in there may get you a quick answer to your question, but we still encourage you to file your inquiry in the appropriate place above to | ||
|
|
||
| ## Contributing to Breakpoint | ||
|
|
||
| We love contributors! Yes we do! If you would like to contribute to Breakpoint, please follow the [Contributing Guidelines](https://github.com/Team-Sass/breakpoint/blob/2.x.x/CONTRIBUTING.md) | ||
|
|
||
| ## Awesome Things Built With Breakpoint | ||
|
|
||
| Breakpoint is designed to be a Media Query engine to power everything from design tweaks to media query contexts to full media query fallbacks. But we also know that our users will build awesome thing with these tools. Build a Breakpoint powered mixin for new media query semantics? We want to hear about it! Build something cool with Context? Let us know! If you would like to add your Awesome Thing to the list, please issue a Pull Request to add it! | ||
|
|
||
| * [Singularity](https://github.com/Team-Sass/Singularity) - Semantic Grid System | ||
| * [Breakpoint Slicer](https://github.com/lolmaus/breakpoint-slicer) - Quick and efficient syntax for Min/Max Width media queries | ||
| We love contributors! Yes we do! If you would like to contribute to Breakpoint, please follow the [Contributing Guidelines](https://github.com/at-import/breakpoint/blob/main/CONTRIBUTING.md) | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under MIT/GPL. | ||
|
|
||
| GPL2 license: | ||
| http:https://www.gnu.org/licenses/gpl-2.0.html | ||
| Licensed under MIT | ||
|
|
||
| MIT license: | ||
| http:https://www.opensource.org/licenses/mit-license.php |