postcss-typescale - npm Package Compare versions

Comparing version 0.1.7 to 0.1.8

package.json

 {
   "name": "postcss-typescale",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "A PostCSS plugin to set type based on a typographic scale.",
@@ -22,5 +22,2 @@ "keywords": [
   "homepage": "http://francoisromain.github.io/postcss-typescale/",
-  "dependencies": {
-    "postcss": "^6.0.1"
-  },
   "scripts": {
@@ -31,2 +28,5 @@ "build": "babel src --out-dir lib",
   "main": "./lib/index.js",
+  "dependencies": {
+    "postcss": "^6.0.1"
+  },
   "devDependencies": {
@@ -33,0 +33,0 @@ "ava": "^0.19.1",

README.md

@@ -83,12 +83,13 @@ # postcss-typescale
 @typescale ([name]) {
-  scale: 1.25;          /* Typographic scale */
-  font-size: 1rem;      /* Default font size */
-  line-height: 1.5rem;  /* Baseline grid */
+  scale: 1.25;          /* typographic scale */
+  font-size: 1rem;      /* default font size */
+  line-height: 1.5rem;  /* baseline grid */
 }
 ```
 
-- _name_ (optional): custom identifier. If no _name_ is provided, the default settings are overwritten.
+- _name_ (optional): custom identifier that allows multiple scales. If not provided, the _default_ settings are overwritten.
+- _scale_: typographic scale.
+- _font-size_: default font size (at _index_ 0).
+- _line-height_: baseline grid. Relative to the font-size if set to 1 without unit.
 
-The line-height can be relative to the font-size if _line-height_ is set to 1 without unit.
-
 * * * 
@@ -98,8 +99,12 @@
 
-`typescale: ([name]) [index] ([line-height-fraction])`
+``` css
+.[your-style] {
+    typescale: ([name]) [index] ([line-height-fraction])
+}
+```
 
-- _name_ (optional, default = _default_): string identifier referring to an atRule settings.
-- _index_: positive or negative integer defining the font-size. font-size = _settings font-size_ * _scale_ <sup>_index_</sup>.
+- _name_ (optional, default = _default_): string identifier referring to the settings. If not provided, the rule refers to the _default_ settings.
+- _index_: null or positive or negative integer defining the font-size. font-size = _settings font-size_ * _scale_ <sup>_index_</sup>.
 - _line-height-fraction_ (optional, default = 1): float or fraction defining the line-height. line-height = _settings line-height_ * _line-height-fraction_.
 
 

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8856

increased by2.2%

Number of package files

9

increased by12.5%

Number of lines in readme file

109

increased by4.81%

No dependency changes