README.md in prawn-emoji-1.0.0 vs README.md in prawn-emoji-1.0.1
- old
+ new
@@ -1,7 +1,8 @@
# Prawn::Emoji
+[](https://badge.fury.io/rb/prawn-emoji)
[](https://travis-ci.org/hidakatsuya/prawn-emoji)
Prawn::Emoji is an extention for [Prawn](https://github.com/prawnpdf/prawn), provides feature for drawing Emoji.
## Installation
@@ -20,27 +21,30 @@
$ gem install prawn-emoji
## Usage
+In order to run the following code, you need to place both [DejaVuSans.ttf](http://sourceforge.net/projects/dejavu/) and [ipag.ttf](http://ipafont.ipa.go.jp/old/ipafont/download.html) in the same directory as the script file.
+
```ruby
require 'prawn'
require 'prawn/emoji'
-Prawn::Docment.generate 'foo.pdf' do
+Prawn::Document.generate 'foo.pdf' do
font 'DejaVuSans.ttf'
- text 'I want to eat ๐ฃ.'
+ text '๐ + ๐ช = ๐ฃ'
font 'ipag.ttf'
text_box '๐ฃใ้ฃในใใ', at: [100, 100], width: 300
draw_text '๐ฃ๐ฃ๐ฃ๐ฃ๐ฃ', at: [100, 200]
end
```
-### CAUTION
-In order to draw emoji, you will need to use a TTF - True Type Font. I strongly recommended you use a Japanese font.
+### IMPORTANT
+
+In order to draw emoji, you must use a TTF - True Type Font. I recommend you use a Japanese font.
## Feature
* [Over 1600 emoji](http://emojione.com) support provided by Emoji One
* RTL support