harsh 0.0.1 → 0.0.2

data/README.md

@@ -1,2 +1,89 @@
-# Harsh
-## Compass extension for randomly generated CSS3 gradients with harsh color stops
+# [Harsh](http://www.bookcasey.com/harsh)
+
+Compass extension for randomly generated CSS3 gradients with harsh color stops—like magical diamonds.
+
+<img src="http://i.imgur.com/bFpC1.png" width="300px" height="200px">
+
+## Installation
+
+From the command line:
+
+    sudo gem install harsh
+
+Installing into your project:
+
+    # Edit config.rb and add:
+    require "harsh"
+
+    # Import the extension into your sass or scss file
+    @import "harsh"
+
+## Arguments
+
+    # Mixin for backgrounds
+    +harsh($color, $background, $transparency, $number-of-gradients, $angle, $nuance, $nuance-strength) 
+
+    # Mixin for text (only works in webkit)
+    +harsh-text($color, $transparency, $number-of-gradients, $angle, $nuance, $nuance-strength, $background) 
+
+### color
+
+The color of the gradients. Pass any color, a list of colors separated by spaces, or `random` for random colors.
+
+### background
+
+Appends a color at the end of the gradients, pass `false` to omit.
+
+### transparency
+
+Sets opacity of each gradient—use `0` for opaque, `1` for completely transparent.
+
+### number-of-gradients
+
+Sets number of gradients. Passing a list of colors overrides.
+
+### angle
+
+Sets angle of gradients. Pass `random` for random angles, start and stop points (`25% 75%`), degrees (`45deg`), or CSS keywords like `top`, `right`, or `bottom left`.
+
+### nuance
+
+Boolean. When passing one color, saturates, desaturates, lightens, and darkens by a random amount. 
+
+### nuance-strength
+
+Sets maximum percent colors will be changed by `nuance`. `0` will result in no change.
+
+<img src="http://i.imgur.com/2I95W.png" width="300px" height="200px">
+
+`100` will result in a large change.
+
+<img src="http://i.imgur.com/2R2cB.png" width="300px" height="200px">
+
+## [Examples](http://www.bookcasey.com/harsh)
+
+    .random
+      +harsh()
+    
+    .background-color
+      +harsh(white, rgb(200,50,50), .95)
+    
+    .bright
+      +harsh(random, white, .05)
+    
+    .dull
+      +harsh($transparency: .95)
+
+    .specify-colors
+      +harsh(#FF0000 blue rgb(50,200,50))
+    
+    .horizontal
+      +harsh($angle: top)
+    
+    .angled
+      +harsh($angle: -32deg)
+    
+    .nuance
+      +harsh(salmon, $nuance-strength: 50)
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harsh
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.10.0.rc3
 description: Compass extension for randomly generated CSS3 gradients with harsh color
-  stops
+  stops—like magical diamonds.
 email: casey.m.olson@gmail.com
 executables: []
 extensions: []
@@ -61,5 +61,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Compass extension for randomly generated CSS3 gradients with harsh color
-  stops
+  stops—like magical diamonds.
 test_files: []