dimus-biodiversity 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,36 @@
+= Biodiversity
+
+Parses species scientific name and breaks it into elements.
+
+== Installation
+
+To install gem you need RubyGems >= 1.2.0
+
+  $ gem sources -a http://gems.github.com (you only have to do this once)
+  $ sudo gem install dimus-biodiversity
+
+== Example usage
+
+* You can parse file with species names from command line. File should contain one scientific name per line
+
+  nnparser file_with_names
+  
+* You can use it as a library
+
+  require 'biodiversity'
+  
+  parser = ScientificNameParser.new
+  
+  # to parse a scientific name 
+  parser.parse("Plantago major")
+  
+  # to clean name up
+  parser.parse("             Plantago       major    ").value
+  
+  # to get only cleaned up latin part of the name
+  parser.parse("Pseudocercospora dendrobii (H.C. Burnett) U. Braun & Crous 2003").canonical
+  
+  # to get detailed information about elements of the name
+  parser.parse("Pseudocercospora dendrobii (H.C. Burnett 1883) U. Braun & Crous 2003").details
+  
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dimus-biodiversity
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dmitry Mozzherin
@@ -27,9 +27,8 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
-- LICENSE
+extra_rdoc_files: []
+
 files: 
 - LICENSE
 - README.rdoc
@@ -43,14 +42,11 @@ files:
 - lib/biodiversity/parser.rb
 - lib/biodiversity.rb
 - bin/nnparse
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/dimus/biodiversity/wikis
 post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-- --inline-source
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement