README.md in caracal-0.1.3 vs README.md in caracal-0.1.4
- old
+ new
@@ -302,11 +302,11 @@
### Fonts
Fonts are added to the font table file by calling the `font` method and passing the name of the font.
-*At present, Caracal only supports declaring the primary font name.
+*At present, Caracal only supports declaring the primary font name.*
```ruby
docx.font do
name 'Droid Serif'
end
@@ -512,18 +512,24 @@
*Caracal will automatically embed the image in the Word document.*
```ruby
docx.img image_url('example.png') do
+ data raw_data # sets the file data directly instead of opening the url
width 396 # sets the image width. units specified in pixels.
height 216 # sets the image height. units specified in pixels.
align :right # controls the justification of the image. default is :left.
top 10 # sets the top margin. units specified in pixels.
bottom 10 # sets the bottom margin. units specified in pixels.
left 10 # sets the left margin. units specified in pixels.
right 10 # sets the right margin. units specified in pixels.
end
```
+
+*Note: If you provide the image data, you should still supply a URL. I know this
+is a bit hacky, but it allows the library to key the image more effectively and
+Caracal needs a file extension to apply to the renamed media file. This seemed
+the simplest solution to both problems.*
### Tables
Tables can be added using the `table` method. The method accepts several optional paramters to control the layout and style of the table cells.