README.md in eulim-0.0.1 vs README.md in eulim-0.0.2
- old
+ new
@@ -1,11 +1,7 @@
# Eulim
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/eulim`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -18,12 +14,35 @@
Or install it yourself as:
$ gem install eulim
+## Modules
+
+* Structrues
+* Chemistry
+
+### Structures
+* Pipe
+
+### Chemistry
+
+* Element
+* Compound
+
+#### Element
+
+* H, He, Li, Be, B, C, N, O, F, Ne, Na, Mg
+* symbol, name, atomic_number, atomic_mass
+
## Usage
-TODO: Write usage instructions here
+ $ Eulim::Chemistry::Element.get_by_symbol("H")
+ => #<Eulim::Chemistry::Element:0x0055ac58c146e8 @symbol="Mg", @name="Magnesium", @atomic_number=12, @atomic_mass=24.305>
+
+ $ Eulim::Chemistry::Element.get_by_atomic_number(12)
+ => #<Eulim::Chemistry::Element:0x0055ac58c146e8 @symbol="Mg", @name="Magnesium", @atomic_number=12, @atomic_mass=24.305>
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.