README.md in rabbit-mm-1.0.0 vs README.md in rabbit-mm-1.1.0
- old
+ new
@@ -1,20 +1,21 @@
# Rabbit-Ruby
[](https://travis-ci.org/Rabbit-Converter/Rabbit-Ruby)
+[](http://badge.fury.io/rb/rabbit-mm)
**Another Zawgyi <=> Unicode Converter as a ruby gem**. Written in [Ruby](https://www.ruby-lang.org/en).
## About
Zawgyi to Unicode has been written in [2011](https://github.com/saturngod/ZG2Uni_JS/commits/master). Now, unicode to zawgyi has been finished.
## Motivation
-When I was writting [ZG2uni](https://github.com/saturngod/ZG2Uni_JS/), [Parabaik](https://github.com/ngwestar/parabaik) is not opensource. At that time, I need to use for [MYSTERY ZILLION](http://www.mysteryzillion.org) for converting the whole database to Unicode.
+When I was writting [ZG2uni](https://github.com/saturngod/ZG2Uni_JS/), [Parabaik](https://github.com/ngwestar/parabaik) was not opensource. At that time, I need to use for [MYSTERY ZILLION](http://www.mysteryzillion.org) for converting the whole database to Unicode.
-For Unicode to Zawgyi, Parabaik is under the GPL license and cannot use in iOS app and Android App. So, I decided to write new one with **WTFPL license**. This ruby gem is under MIT License.
+For Unicode to Zawgyi, Parabaik is under the ~~GPL license and cannot use in iOS app and Android App~~ LGPL. So, I decided to write new one with **WTFPL license**. This ruby gem is under MIT License.
> I cannot promise , it's correct 100% after converting.
> If you are not using in app or program and just for converting the text , please use [Parabaik](https://github.com/ngwestar/parabaik)
@@ -49,13 +50,23 @@
rabbit.zg2uni("မဂၤလာပါ") # returns unicode strings "မင်္ဂလာပါ"
```
+## JRuby Support ?
+
+Yes. Tested with jruby-1.7.20
+
## Contributing
1. Fork it ( https://github.com/Rabbit-Converter/Rabbit-Ruby )
2. Create your feature branch (`git checkout -b my-new-feature`)
+ - Install ruby with [rvm](http://rvm.io), if you haven't.
+ - Run `bundle install`
+ - Add a test case.
+ - Implement the code.
+ - Make the tests pass.
+ - You can run with `rake test` or just `rake` in the repo.
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License