quarrel 0.0.2 → 0.0.3

data/README.md

@@ -16,9 +16,40 @@ Or install it yourself as:
 
     $ gem install quarrel
 
+## Syntax
+
+Quarrel uses a simple shorthand syntax to define named parameters. You can use any combination of these to specify
+the named parameters for Quarrel's methods:
+
+* Required parameter: A symbol ending in an alphanumeric character, ie: `:city` or `:address1`
+* Optional parameter: A symbol ending with a question mark, ie: `:zip?`
+* Defaulted parameter: A symbol ending with an equals sign, and followed by its default value, ie: `:country=, "US"`
+
 ## Usage
 
-TODO: Write usage instructions here
+Using Quarrel is simple. Just require the quarrel gem, and then call the method you need for your use case:
+
+### Getting values from named parameters
+
+    def foo params
+      city, state, zip, country = Quarrel.values params, :city, :state, :zip?, :country=, "US"
+    end
+
+### Setting instance variables from named parameters
+
+    def initialize params
+      Quarrel.set_instance_variables self, params, :city, :state, :zip?, :country=, "US"
+    end
+
+### Checking for unset values from optional parameters
+
+Quarrel uses a Special Type object to represent unset values for optional parameters. To determine
+if a value was not supplied for an optional parameter, call the `unset?` method:
+
+    def foo params
+      city, state, zip, country = Quarrel.values params, :city, :state, :zip?, :country=, "US"
+      if Quarrel.unset?(zip) # ...
+    end
 
 ## Contributing
 

data/lib/quarrel/version.rb

@@ -1,3 +1,3 @@
 module Quarrel
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quarrel
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4366834569935779222
+      hash: -2166998906202398430
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4366834569935779222
+      hash: -2166998906202398430
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25