electric 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02742beca6cabb448b85703e30cdc829008f4129
-  data.tar.gz: 7a471903b9aa74579dbb9db0f2ce458d2e8167e3
+  metadata.gz: 35f89c80c18ec3cc1bb84c36880b42c2ab55c0a0
+  data.tar.gz: 050c9b402d0b7a7448664818684edd1c5b7446b5
 SHA512:
-  metadata.gz: 743679e89445520340da808332e78f63f222fb7aae0b5d5b8e4067ca0bf76eefcc5a323b656259c6f04c639aba3b0041ccc2791de5f90af79a77cfeddd60af1c
-  data.tar.gz: 7e63781573ee7525f5328555d87b19cb7a25eb445c7b81e4a48733224e23de8482df947b8b01f502ec2115c816166be48a846e409acf91868bbae5a8089dee51
+  metadata.gz: faf6ba1905bf0c341b0962c814bc3b396874c4e84a3b99678738481b014da3fdfff690d69a062ef3aafdaf759d515fdf9073f76e24bcf66b0208b7423caf87f6
+  data.tar.gz: d10ed648975f54ab0b746a8b1334f40c4ddc84652750cca713d011ce99afc1c34173f8663966a1ab8726b2e8a62b112e143ac78b9eae374768023444119c8ae8

data/README.md

@@ -1,11 +1,31 @@
 ## Ruby Library for electronics
 
 ### Resistor Color Code Calculator
-Electric::Resistor.new("red", "black", "brown").human_readable
+
+Accepts 4 arguments (first 3 bands determine resistor value, 4th band is for tolerance %), though none are required to return a value of 0 ohms. You must preserve order of bands as arguments.
+
+resistor = Electric::Resistor.new("red", "black", "brown")
+resistor.value
+=> 200
+resistor.tolerance
+=> "5%"
+resistor.human_readable
+=> "200 ohms, +/- 5%"
 
 ### Ohm's Law Calculator
-Electric::Ohm.new(:volts => 5, :ohms => 330).current
 
+Accepts 4 named arguments: "volts", "ohms", "amps", and "watts" in any order. You must provide at least 2 properties to calculate other 2. 
+
+There are 4 methods that can be called to run calculations: "resistance", "power", "voltage", and "current"
+
+Electric::Ohm.new(:volts => 5, :ohms => 330).voltage
+=> 5.0
+Electric::Ohm.new(:volts => 5, :ohms => 330).resistance
+=> 330.0
+Electric::Ohm.new(:volts => 5, :ohms => 330).current
+=> 0.015151515151515152
+Electric::Ohm.new(:volts => 5, :ohms => 330).power
+=> 0.07575757575757576
 
 
 More documentation on the way...

data/lib/electric/ohm.rb

@@ -48,8 +48,8 @@ module Electric
         # I * R
         amps * ohms
       elsif watts && amps
-        # P / I^2
-        watts / (amps * amps)
+        # P / I
+        watts / amps
       elsif ohms && watts
         # sq_root(P * R)
         sqrt(watts * ohms)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: electric
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - JD Warren