sane-scale 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1c3c844f2da6800cc3529504aeb55450d04b506
-  data.tar.gz: b19e2024fc6edf08ae908ebbb754d55a9ad9bf5b
+  metadata.gz: c5734fde33fb8a03d19b896e40a7bfe4d74666a5
+  data.tar.gz: d2d5e9bdb9d31bdb78728f943d05d0a29955d01c
 SHA512:
-  metadata.gz: 351aeacda072ea1ee1ef212703139bdbe357beb3090a041d529b1aafd30c0fa05f84c45604b3699570ce7f168c86f9d5c6b0fb2848407865d03fc03c92f387a7
-  data.tar.gz: 1c28ba05d43e6ebefd652160702160ee808a5a8c56a0c0003df65a48f89f11349137796db58270ddc6a7c6c0d6df17baa21ed424a95e17377e72b1c277480c97
+  metadata.gz: 6a9a2ed2c1a1335f6337d3b52dca1463d8eadc276f034f61a891924480b3d6990111ac0c9ef7d5e241ce40300acd68b2f7fc50d186198ddaf29bec7c429f0518
+  data.tar.gz: a2475167ce92d286c5f204199ff19a2faf30ff51db99cf018162e71ffbf706ece68ea08c198b6b4c492fe29856e7976cd427f7c05bd4910e8c4fa4a061dfd665

data/README.md

@@ -2,18 +2,24 @@
 
 Sane Scale is a framework for defining and applying typographic styles. Its goal is to generate a complex, nuanced typographic system from only a few key variables. 
 
+
+
 ## Features
 
 1. Modular. Typographic measurements are based on proportional lists of values. 
 2. Responsive. Typography adjusts to the constraints of each breakpoint.
 3. Font rebalancing. Different fonts set to the same size often don't appear to be. Fonts are normalized, so every font appears to be exactly the size you intend.
 
+
+
 ## Install 
 
 * Terminal: `gem install sane-scale`
 * Compass config.rb: `require 'sane-scale'`
 * SCSS: `@import 'sane-scale';`
 
+
+
 ## Usage
 
 ### Declare your fonts
@@ -41,13 +47,15 @@ $font-feather: (
 );
 ```
 
-Oftentimes two fonts set to different sizes do not appear to be the same size. This is because the height of their lowercase letters is not equal. The `normalize-ratio` is the ratio we'll use to adjust the size of anything set in this font. 
+Oftentimes two fonts set to the same size do not appear to be. This is because the heights of their lowercase letters are not equal. By using the `normalize-ratio` property, additional fonts can be normalized to the default font. This will ensure they align to the modular scale.
+
+As an example, Verdana appears 11% larger than Georgia. To normalize it with Georgia, we can set a `normalize-ratio: 0.89`. This will cause Verdana to be 11% smaller than Georgia when both are set to the same size.
+
 
-For example, Verdana appears 11% larger than Georgia. To normalize it with Georgia, we need to decrease size by 11% (normalize-ratio: 0.89). The normalized sizes of Verdana will appear to be the same size as Georgia.
 
 ### Define your breakpoints
 
-Sane scale uses a SASS map of breakpoints (with relevant parameters) in the following format:
+Sane Scale uses a SASS map of breakpoints (with relevant parameters) in the following format:
 
 ```scss
 $breakpoints: (	
@@ -72,9 +80,11 @@ $breakpoints: (
 	)
 ); 
 ```
-For each breakpoint, you'll need to specify a font-size and line-height for both the base size and the max size. Additional sizes and line-heights will be interpolated from these constraints.
+For each breakpoint, you'll need to specify a font-size and line-height for both the base size and the max size. Additional font-sizes and line-heights will be interpolated from these constraints.
+
+A `media-query` property should also be set for each, exluding the default breakpoint. Feel free to name the other breakpoints whatever you like.
+
 
-You'll also need to specify a `media-query` for all breakpoints, excluding your `default` breakpoint. Feel free to name the other breakpoints whatever you like.
 
 ### Build the scale
 
@@ -86,28 +96,30 @@ $numb-larger-sizes: 4;
 
 $sane-scale: ss-make-responsive-font-scale($breakpoints, $numb-smaller-sizes, $numb-larger-sizes);
 ```
-That's it! Note that `sane-scale` is a key variable. This map will be used by the following mixins to lookup and apply sizes.
+That's it! Note that `$sane-scale` is a key variable. This map will be used by the following mixins to lookup and apply sizes.
+
+
 
 ### Apply responsize sizing
 
 Use `@include ss-set-responsive-font-size($font, $size)` to apply a responsive size. The sizes available to you are based on your parameters: 
 * 0 is your base size.
-* 1, 2, 3... are your increasingly large sizes.
-* -1, -2, -3... are your increasingly small sizes.
+* 1, 2, 3... are your increasingly larger sizes.
+* -1, -2, -3... are your increasingly smaller sizes.
 
 ```scss
-p.lead {
+.lead {
 	@include ss-set-responsive-font-size($font-georgia, 1);
 }
 ```
-We just created a responsive lead paragraph style. It will use `$font-georgia` at size 1 for each breakpoint: 20.1px by default, and then resizing to 24.1px for tablets and larger.
+We just applied responsive styling to a lead paragraph style. It will use `$font-georgia` at size 1 for each breakpoint: 20.1px by default, and then resizing to 24.1px for tablets and larger.
 
 ```scss
 .h4 { 
 	@include ss-set-responsive-font-size($font-verdana, 1);
 }
 ```
-We justed used the same size `.h4` heading, but with `$font-verdana`. That will result in a font-size of 17.9px by default and 21.4px for tablets and larger. Mathematically different, but visually equal.
+We used the same size for the `.h4` heading, but with `$font-verdana`. That will result in a font-size of 17.9px by default and 21.4px for tablets and larger. Mathematically different, but visually equal.
 
 
 

data/lib/sane-scale.rb

@@ -16,7 +16,7 @@ Compass::Frameworks.register('sane-scale', :path => extension_path)
 # version contains alphas, it will be created as a 
 # prerelease version. Date is in the form of YYYY-MM-DD
 module SaneScale
-  VERSION = "0.1"
+  VERSION = "0.1.1"
   DATE = "2016-05-09"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sane-scale
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - David Fusilier
@@ -14,28 +14,28 @@ dependencies:
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: compass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
 description: Modular, responsive, scalable typography
@@ -53,7 +53,7 @@ files:
 - stylesheets/sane-scale/_make-scale.scss
 - stylesheets/sane-scale/_map-deep-get.scss
 - stylesheets/sane-scale/_set-font-size.scss
-homepage: http://www.davidfusilier.com
+homepage: https://github.com/dfusilier/sane-scale.git
 licenses: []
 metadata: {}
 post_install_message: 
@@ -62,17 +62,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: sane-scale
-rubygems_version: 2.6.4
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A SASS framework for defining and applying typographic styles. Generate a