elementy 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # Elementy
 
-TODO: Write a gem description
+This is a simple gem to lookup elements in the periodic table.
 
 ## Installation
 
@@ -18,7 +18,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Usage is pretty simple:
+
+```ruby
+require 'elementy'
+
+Elementy.search 2
+# => #<Elementy::Element @group="Element Noble p", @position=17, @number=2, @name="Helium", @molar=4.002602, @symbol="He", @electrons=[2]>
+
+Elementy.search 'C'
+# => #<Elementy::Element:0x007fab5bb352f0 @group="Element Nonmetal Carbon p", @position=13, @number=6, @name="Carbon", @molar=12.0107, @symbol="C", @electrons=[2, 4]>
+
+Elementy.search 'einsteinium'
+# => #<Elementy::Element @group="Element Actinoid f", @position=12, @number=99, @name="Einsteinium", @molar=252, @symbol="Es", @electrons=[2, 8, 18, 32, 29, 8, 2]>
+```
+
+You can also use it on the command line
+
+```bash
+$ elementy 42
+   symbol:      Mo
+   name:        Molybdenum
+   number:      42
+   molar:       95.96
+   position:    5
+   group:       Element Transition d
+   electrons:   [2, 8, 18, 13, 1]
+```
 
 ## Contributing
 

data/lib/elementy.rb

@@ -6,5 +6,14 @@ module Elementy
     def root
       File.dirname(File.dirname(__FILE__))
     end
+
+    # Searches for and returns and element if found.
+    #
+    # @param term [string, symbol, integer] the name, symbol, or atomic
+    # number to search for
+    # @return [Elementy::Element]
+    def search(term)
+      Elementy::Element.search term
+    end
   end
 end

data/lib/elementy/version.rb

@@ -1,3 +1,3 @@
 module Elementy
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elementy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler