README.md in mmfont-1.0.0 vs README.md in mmfont-1.0.1
- old
+ new
@@ -1,9 +1,16 @@
# Mmfont
-A simple gem which converts zawgyi1 <=> unicode strings.
+[![Build Status](https://travis-ci.org/yelinaung/mmfont.svg)](https://travis-ci.org/yelinaung/mmfont)
+[![Gem Version](https://badge.fury.io/rb/mmfont.svg)](http://badge.fury.io/rb/mmfont)
+[![Dependency Status](https://gemnasium.com/yelinaung/mmfont.svg)](https://gemnasium.com/yelinaung/mmfont)
+[![Inline docs](http://inch-ci.org/github/yelinaung/mmfont.png?branch=master)](http://inch-ci.org/github/yelinaung/mmfont)
+A simple gem which converts zawgyi1 <=> unicode strings. It uses the rules from [paytan](https://github.com/trhura/paytan) and basically, the ruby converter.
+It's written with TDD. Special thanks to [@steveklabnik](https://github.com/steveklabnik) for his tutorials [How I Start Ruby](http://www.howistart.org/posts/ruby/1).
+
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -11,17 +18,17 @@
```
And then execute:
```bash
- $ bundle
+$ bundle
```
Or install it yourself as:
```bash
- $ gem install mmfont
+$ gem install mmfont
```
## Usage
```ruby
@@ -35,17 +42,17 @@
```
## Is it fast ?
I am not sure. But of course, Ruby is basically slow, regardless of implementations, compared to Nodejs, Go, Rust etc.
-Feel free to send me some bunchmarks.
+Some benchmarks, maybe ?
## TODO
- ~~Write TESTS!~~
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/mmfont/fork )
+1. Fork it ( https://github.com/yelinaung/mmfont )
2. Create your feature branch (`git checkout -b my-new-feature`)
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