myanmar-tools 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27c05762be9208077e9951f6d19e03482f225aba42c41c1ab122b987c284f29
-  data.tar.gz: d9f6b57cd196fdc8bc263a23c9c79d6b70c8e8b169428ff24cff635effba4204
+  metadata.gz: 7fe5046c36d1fa57bb056fdd103f13c693342990e5df99b25b47a4e2330fd2ee
+  data.tar.gz: d73e7f38c95b093c74c185353040ee02436e9afd86e5ed2c21bd548586e5151c
 SHA512:
-  metadata.gz: 4c70ab77d5c7eed697803fd416cd55148457a88369faec8a46823c63c76d576d5b6a942c2c0a37efbd404224d10ee0228c543766006210f165a8c9d16fc3f52e
-  data.tar.gz: fd32f0c61f8bc5112f4132580e23bb153a104005cf3635baf50b018f55da942ee610b42b213c004742f6453b1495ebe28f7780a47f8d2c8ca5d72cb3507484bb
+  metadata.gz: 10a8cc29a764b8c95eb14b4ca497a16ba4e54577c58860785f87ec019e2bc968f8ac41cedd8c88fd303429da22c8ee3f500af2240d635d273ee5e52a75f40738
+  data.tar.gz: df22cc42616d9e2ce6499f74fbe9e5bdb9f184c01be85d2ec3702ab7ba3a5716a6c822c0da7f7d55cd912a15a40f0f6e9f407a0eb57d7156cb66a5a108a6ad89

data/README.md

@@ -1,28 +1,30 @@
 # Myanmar Tools Ruby Documentation
 
-This documentation is for Ruby specific usage of Myanmar Tools. For general documentation, see [the top-level README](../../README.md).
+This documentation is for Ruby specific usage of *Myanmar Tools*. For general documentation, see [the top-level README](../../README.md).
 
 ## Ruby Usage
 
 Prerequisites: Ruby >= 2.0.0-p0 and bundler >= 1.0
 
-As this client is not released as a gem to rubygems yet, please check out the repo first and follow the steps to use:
+Add the dependency to your project:
 
-1. After checking out the repo, go to `clients/ruby` folder and run `$ bundle install` to install dependencies.
+```bash
+$ gem install myanmar-tools
+```
 
-2. Run `$ rake test` to run the test-cases.
+To detect Zawgyi, create an instance of ZawgyiDetector, and call `get_zawgyi_probability` with your string.
 
-3. Run `$ bundle exec rake build` in order to build the gem.
-
-4. To install this gem onto your local machine, run `$ bundle exec rake install`.
-
-5. Run `$ bundle console` for an interactive prompt that will allow you to experiment by loading the myanmar-tools gem.
-
-6. Once irb session is available, create an object by running `detector=MyanmarTools::ZawgyiDetector.new` and run `detector.get_zawgyi_probability("အပြည်ပြည်ဆိုင်ရာ လူ့အခွင့်အရေး ကြေညာစာတမ်း")` to get score of the input.
+```ruby
+require 'myanmar-tools'
+detector = MyanmarTools::ZawgyiDetector.new
+score    = detector.get_zawgyi_probability('အျပည္ျပည္ဆိုင္ရာ လူ႔အခြင့္အေရး ေၾကညာစာတမ္း')
+# score is 1.0 (The input is definitely Zawgyi)
+```
 
+For a complete working example, see [samples/ruby/demo.rb](../../samples/ruby/demo.rb).
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kirankarki/myanmar-tools/tree/master/clients/ruby/zawgyidetector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/googlei18n/myanmar-tools . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -30,4 +32,4 @@ The gem is available as open source under the terms of the [Apache-2.0 License](
 
 ## Code of Conduct
 
-Everyone interacting in the Zawgyidetector project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zawgyidetector/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Myanmar-Tools project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zawgyidetector/blob/master/CODE_OF_CONDUCT.md).

data/lib/myanmar-tools/version.rb

@@ -1,3 +1,3 @@
 module MyanmarTools
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/myanmar-tools.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Tools for handling the Zawgyi font encoding in Myanmar.'
   spec.description   = 'Tools for handling the Zawgyi font encoding in Myanmar.'
   spec.homepage      = 'https://github.com/googlei18n/myanmar-tools'
+  spec.required_ruby_version = '>= 2.0.0'
   spec.license       = 'Apache-2.0'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myanmar-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aung Kyaw Phyo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="