README.rdoc in gimchi-0.1.0 vs README.rdoc in gimchi-0.1.1

- old
+ new

@@ -1,22 +1,25 @@ -# encoding: UTF-8 - = gimchi Gimchi is a simple Ruby gem which knows how to handle Korean strings. It knows how to dissect Korean characters into its 3 components, namely chosung, jungsung and optional jongsung. It knows how Korean sentences are pronounced and how they're written in roman alphabet. Gimchi (only partially) implements the following rules dictated by The National Institute of The Korean Language (http://www.korean.go.kr) * Korean Standard Pronunciation -* Korean romanization +* Korean Romanization +== Installation + gem install gimchi + == Usage === Creating Gimchi::Korean instance + require 'gimchi' + ko = Gimchi::Korean.new === Checks if the given character is in Korean alphabet ko.korean_char? 'ㄱ' # true ko.complete_korean_char? 'ㄱ' # false @@ -51,11 +54,10 @@ arr[4].partial? # true === Reading numbers in Korean ko.read_number(1999) # "천 구백 구십 구" ko.read_number(- 100.123) # "마이너스 백점일이삼" - ko.read_number("153,101,202,333.321") ko.read_number("153,191,100,678.3214") # "천 오백 삼십 일억 구천 백 십만 육백 칠십 팔점삼이일사" # Age, Time ( -살, -시 ) ko.read_number("20살") # "스무살" @@ -89,16 +91,16 @@ # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim 7 si 30 bunkkaji uril jogeuman gyosillo moraneoko" == Limitation of the implementation Unfortunately in order to implement the complete specification of Korean -pronunciation and romanization, we need NLP, hugh Korean dictionaries and even +pronunciation and romanization, we need NLP, huge Korean dictionaries and even semantic analysis of the given string. And even with all those complex processing, we cannot guarantee 100% accuracy of the output. So yes, that is definitely not what this gem tries to achieve. Gimchi tries to achieve "some" level of accuracy with relatively simple code. -Currently, Gimchi code containts a lot of ad-hoc (possibly invalid) patches +Currently, Gimchi code contains a lot of ad-hoc (possibly invalid) patches that try to improve the quality of the output, which should better be refactored anytime soon. == Contributing to gimchi