csstyle - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

CONTRIBUTING.md

@@ -13,2 +13,5 @@ # Contributing
 
-`$ npm test`
+`$ npm test`
+
+## Version Bumping
+Please don't bump the version in your commits. Just add a note to the PR if you'd like a major/minor/patch bump and I'll use [grunt-release](https://github.com/geddski/grunt-release) to quickly cut a new release.

csstyle.js

@@ -1,2 +0,2 @@
-// csstyle v1.3.1 for postcss
+// csstyle for postcss
 // Clean, Simple Styling for the Web
@@ -3,0 +3,0 @@ // http://www.csstyle.io

package.json

 {
   "name": "csstyle",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "clean, simple styling for styling the web.",
@@ -18,3 +18,5 @@ "directories": {
     "shelljs": "~0.3.0",
-    "specificity": "~0.1.4"
+    "specificity": "~0.1.4",
+    "grunt": "~0.4.5",
+    "grunt-release": "~0.12.0"
   },
@@ -21,0 +23,0 @@ "main": "csstyle.js",

README.md

 # [csstyle](http://csstyle.io)
-[![csstyle](https://github.com/geddski/csstyle/blob/master/site/common/images/csstyle.png)](http://csstyle.io)  
+[![csstyle](https://github.com/geddski/csstyle/blob/master/site/common/images/csstyle.png)](http://csstyle.io)
 
@@ -34,5 +34,5 @@ Clean, simple, for styling the web.
 ```js
-postcss([require('postcss-nested'), require('../csstyle')]);
+postcss([require('postcss-nested'), require('csstyle')]);
 ```
-Be sure to include postcss-nested and csstyle in that order. 
+Be sure to include postcss-nested and csstyle in that order.
 
@@ -44,4 +44,4 @@ Now you're set and can start creating components with options & parts, adding in tweaks and locations as needed. Enjoy!
 ### Can I use this with Libsass?
-People using webpack or similar often want to load Sass via libsass. 
-Unfortunately libsass is quite behind the ruby Sass and some things are [still missingl](https://sass-compatibility.github.io/)
+People using webpack or similar often want to load Sass via libsass.
+Unfortunately libsass is quite behind the ruby Sass and some things are [still missing](https://sass-compatibility.github.io/)
 before it will work with csstyle. As a workaround while we wait for libsass you
@@ -60,3 +60,6 @@ can load your Sass files with the [ruby Sass loader](https://github.com/ddelbondio/ruby-sass-loader) and it will work just fine, it just
     background: orange;
-    :hover & {
+  }
+  
+  &:hover & {
+    @include part(flux){
       background: blue;
@@ -68,5 +71,14 @@ }
 
-### Can I configure the styling convention?
-You can configure which symbol is used to denote `parts` by changing the `$csstyle-part-symbol` variable. The default is `__` but you can set it to `-` or whatever suits your style.
+### Can I configure the styling convention (SASS)?
+There are a few settings you can change. You can set these to whatever suits your style.
 
+ - The style to denote `options` by changing the `$csstyle-option-symbol` variable. The default is `\--`.
+ - The style to denote `parts` by changing the `$csstyle-part-symbol` variable. The default is `__`.
+ - The style to denote `tweaks` by changing the `$csstyle-tweak-symbol` variable. The default is `\+`.
+ - The style to denote `locations` by changing the `$csstyle-location-symbol` variable. The default is `\@`.
+
+**All characters besides `_` need to be escaped!** However, if you are using dashes, only _the first one_ needs to be escaped. Use two backslashes to properly escape in SASS. For example to use a forward slash to separate parts, set $csstyle-part-symbol to `\\/`.
+
+In adition to that, you can also change your app's root `id` on the html or body element by changing the `$csstyle-root-id` variable. The default is `csstyle`.
+
 ## License
@@ -73,0 +85,0 @@ MIT

No alert changes

Improved metrics

Total package byte prevSize

270719

7.41%

Number of package files

79

6.76%

Lines of code

105

3.96%

Number of lines in readme file

85

16.44%

Worsened metrics

Dev dependency count

9

28.57%

No dependency changes