myanmar-tools 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -13
  3. data/lib/myanmar-tools/version.rb +1 -1
  4. data/myanmar-tools.gemspec +1 -0
  5. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e27c05762be9208077e9951f6d19e03482f225aba42c41c1ab122b987c284f29
4
- data.tar.gz: d9f6b57cd196fdc8bc263a23c9c79d6b70c8e8b169428ff24cff635effba4204
3
+ metadata.gz: 7fe5046c36d1fa57bb056fdd103f13c693342990e5df99b25b47a4e2330fd2ee
4
+ data.tar.gz: d73e7f38c95b093c74c185353040ee02436e9afd86e5ed2c21bd548586e5151c
5
5
  SHA512:
6
- metadata.gz: 4c70ab77d5c7eed697803fd416cd55148457a88369faec8a46823c63c76d576d5b6a942c2c0a37efbd404224d10ee0228c543766006210f165a8c9d16fc3f52e
7
- data.tar.gz: fd32f0c61f8bc5112f4132580e23bb153a104005cf3635baf50b018f55da942ee610b42b213c004742f6453b1495ebe28f7780a47f8d2c8ca5d72cb3507484bb
6
+ metadata.gz: 10a8cc29a764b8c95eb14b4ca497a16ba4e54577c58860785f87ec019e2bc968f8ac41cedd8c88fd303429da22c8ee3f500af2240d635d273ee5e52a75f40738
7
+ data.tar.gz: df22cc42616d9e2ce6499f74fbe9e5bdb9f184c01be85d2ec3702ab7ba3a5716a6c822c0da7f7d55cd912a15a40f0f6e9f407a0eb57d7156cb66a5a108a6ad89
data/README.md CHANGED
@@ -1,28 +1,30 @@
1
1
  # Myanmar Tools Ruby Documentation
2
2
 
3
- This documentation is for Ruby specific usage of Myanmar Tools. For general documentation, see [the top-level README](../../README.md).
3
+ This documentation is for Ruby specific usage of *Myanmar Tools*. For general documentation, see [the top-level README](../../README.md).
4
4
 
5
5
  ## Ruby Usage
6
6
 
7
7
  Prerequisites: Ruby >= 2.0.0-p0 and bundler >= 1.0
8
8
 
9
- As this client is not released as a gem to rubygems yet, please check out the repo first and follow the steps to use:
9
+ Add the dependency to your project:
10
10
 
11
- 1. After checking out the repo, go to `clients/ruby` folder and run `$ bundle install` to install dependencies.
11
+ ```bash
12
+ $ gem install myanmar-tools
13
+ ```
12
14
 
13
- 2. Run `$ rake test` to run the test-cases.
15
+ To detect Zawgyi, create an instance of ZawgyiDetector, and call `get_zawgyi_probability` with your string.
14
16
 
15
- 3. Run `$ bundle exec rake build` in order to build the gem.
16
-
17
- 4. To install this gem onto your local machine, run `$ bundle exec rake install`.
18
-
19
- 5. Run `$ bundle console` for an interactive prompt that will allow you to experiment by loading the myanmar-tools gem.
20
-
21
- 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.
17
+ ```ruby
18
+ require 'myanmar-tools'
19
+ detector = MyanmarTools::ZawgyiDetector.new
20
+ score = detector.get_zawgyi_probability('အျပည္ျပည္ဆိုင္ရာ လူ႔အခြင့္အေရး ေၾကညာစာတမ္း')
21
+ # score is 1.0 (The input is definitely Zawgyi)
22
+ ```
22
23
 
24
+ For a complete working example, see [samples/ruby/demo.rb](../../samples/ruby/demo.rb).
23
25
  ## Contributing
24
26
 
25
- 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.
27
+ 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.
26
28
 
27
29
  ## License
28
30
 
@@ -30,4 +32,4 @@ The gem is available as open source under the terms of the [Apache-2.0 License](
30
32
 
31
33
  ## Code of Conduct
32
34
 
33
- 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).
35
+ 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 CHANGED
@@ -1,3 +1,3 @@
1
1
  module MyanmarTools
2
- VERSION = '0.1.0'
2
+ VERSION = '0.1.1'
3
3
  end
data/myanmar-tools.gemspec CHANGED
@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
12
12
  spec.summary = 'Tools for handling the Zawgyi font encoding in Myanmar.'
13
13
  spec.description = 'Tools for handling the Zawgyi font encoding in Myanmar.'
14
14
  spec.homepage = 'https://github.com/googlei18n/myanmar-tools'
15
+ spec.required_ruby_version = '>= 2.0.0'
15
16
  spec.license = 'Apache-2.0'
16
17
 
17
18
  spec.files = `git ls-files -z`.split("\x0").reject do |f|
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: myanmar-tools
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Aung Kyaw Phyo
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-03-13 00:00:00.000000000 Z
11
+ date: 2018-03-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
87
87
  requirements:
88
88
  - - ">="
89
89
  - !ruby/object:Gem::Version
90
- version: '0'
90
+ version: 2.0.0
91
91
  required_rubygems_version: !ruby/object:Gem::Requirement
92
92
  requirements:
93
93
  - - ">="