diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/README.md b/README.md index 4fd89f1a..0e2035f4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
- [![v.0.5.5](https://img.shields.io/badge/cirrus-0.5.5-blue.svg?style=flat-square)](https://github.com/Spiderpig86/Cirrus) + [![v.0.5.5](https://img.shields.io/badge/cirrus-0.6.0-blue.svg?style=flat-square)](https://github.com/Spiderpig86/Cirrus) [![MIT License](https://img.shields.io/github/license/Spiderpig86/Cirrus.svg?style=flat-square)](https://opensource.org/licenses/MIT) [![Travis](https://img.shields.io/travis/Spiderpig86/Cirrus.svg?style=flat-square)](https://travis-ci.org/Spiderpig86/Cirrus) [![Known Vulnerabilities](https://snyk.io/test/github/Spiderpig86/Cirrus/badge.svg?targetFile=package.json&style=flat-square)](https://snyk.io/test/github/Spiderpig86/Cirrus?targetFile=package.json) @@ -45,16 +45,17 @@ https://unpkg.com/cirrus-ui ``` ## :sparkles: Why not other frameworks? -Even with a multitude of CSS frameworks, some are either too basic to develop more complex websites and some are too bogged down with a lot of styles that don't end up getting used. Cirrus is meant to bridge a gap between boilerplate stylesheets and UI frameworks. +Even with a multitude of CSS frameworks, some are either too basic that require lots of custom styling and some are too bogged down with a lot of styles that don't end up getting used. Cirrus is meant to bridge a gap between boilerplate stylesheets and UI frameworks. -* :zap: **Lightweight** - Cirrus consists of a single minified file using only **9.61kb** and **17.2kb** respectively. +* :zap: **Lightweight** - Cirrus consists of a single minified file using only **10.3kb** and **17.2kb** respectively. * :gift: **Beautiful Components** - Construct your web app or website using by composing beautifully designed components. * :gem: **Clean** - Styles are easy to follow and written using [BEM Notation](http://getbem.com/introduction/). * :iphone: **Responsive** - Fully responsive by design. +* :ship: **Modular** - Import what you need.
## :dart: Supported Browsers -Cirrus relies on [What CSS to prefix?](http://shouldiprefix.com/) to determine which selectors need preprocessors. +Cirrus relies on [What CSS to prefix?](http://shouldiprefix.com/) to determine which selectors need prefixes. | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | [Opera](http://godban.github.io/browsers-support-badges/)
Opera | [Electron](http://godban.github.io/browsers-support-badges/)
Electron | | --- | --- | --- | --- | --- | --- | @@ -79,9 +80,10 @@ The `helpers` folder contains configurations, utilities, and other styles shared * [Links](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/links.scss "Links") - Link styles with different effects. * [Lists](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/lists.scss "Lists") - A simple stylesheet to simplify list UI. * [Media](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/media.scss "Media") - Rules for styling images, videos, figures, avatars, and other media components. +* [Tables](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/spacing.scss "Tables") - Classes for margin/padding. * [Tables](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/table.scss "Tables") - Clean designs for tables. * [Theme](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/theme.scss "Theme") - Default colors of the framework. -* [Util](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/util.scss "Utils") - Designed to solve many common headaches with CSS. +* [Util](https://github.com/Spiderpig86/Cirrus/blob/master/src/core/utils "Utils") - Designed to solve many common headaches with CSS and provide flexibility for modifying existing classes. #### Ext * [Animations](https://github.com/Spiderpig86/Cirrus/blob/master/src/ext/animations.scss "Animations") - Consists of animations that will work with the controls. @@ -100,7 +102,8 @@ The `helpers` folder contains configurations, utilities, and other styles shared
## :pager: jQuery -* The only component that requires the use of jQuery is the `Header` component for toggling the dropdown menu on mobile. +* jQuery is **not needed** in order to use this framework. +* You may use jQuery for adding functionality such as toggling the dropdown menu for the `Header` component on mobile devices, but you can accomplish the same thing with vanilla JavaScript. * It is possible to use these components without jQuery in other frameworks like Angular and React by mimicking the behavior of toggling the class.