phonem_encoder 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,4 @@
-# PHOMEN Encoder
+# PHONEM Encoder
 
 Encode a string with the PHONEM algorithm. This gem can be used for finding strings by their phonetic sound - optimized for the german language.
 
@@ -30,6 +30,11 @@ Call `phonetic_encode` on any string to get the phonetic code of the string.
 This will output "mylr"
 
 
+## Documentation
+
+[http://rubydoc.info/gems/phonem_encoder/frames](http://rubydoc.info/gems/phonem_encoder/frames)
+
+
 ## Development
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/arndttouby/phonem_encoder/issues).
@@ -44,4 +49,4 @@ Questions or problems? Please post them on the [issue tracker](https://github.co
 5. Create new Pull Request
 
 
-This gem is craeted by Arndt Touby and is under the MIT License.
+This gem is created by Arndt Touby and is under the MIT License.

data/lib/phonem_encoder/CHANGELOG

@@ -1,3 +1,7 @@
+## v0.0.2
+
+* Corrected some typos
+
 ## v0.0.1
 
-* Initial release
+* Initial release

data/lib/phonem_encoder/version.rb

@@ -1,3 +1,3 @@
 module PhonemEncoder
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/phonem_encoder.rb

@@ -64,6 +64,16 @@ module PhonemEncoder
     end
   end
 
+
+  # To  Encode a string based on the PHONEM algorithm, call <tt>encode_string</tt>
+  # on any String.
+  #
+  #     "Müller".encode_string
+  #
+  # This will output "mylr".
+  #
+  # This can be used for finding strings by their phonetic sound.
+  # It is optimized for the german language.
   def phonetic_code
     PhonemEncoder.encode_string self.to_s
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: phonem_encoder
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Arndt Touby