README.md in psd_native-0.1.0 vs README.md in psd_native-0.2.0
- old
+ new
@@ -1,13 +1,13 @@
# PSDNative
-A gem that includes multiple mixins that speed up [PSD.rb](https://github.com/layervault/psd.rb) by delegating certain parts of the library to native C code. This library allows for PSD.rb to function as a pure Ruby library, while allowing for optional native code speed improvements. It overwrites specific methods within PSD.rb transparently, so you can use PSD.rb as you normally would.
+A gem that includes multiple mixins that speed up [PSD.rb](https://github.com/layervault/psd.rb) by delegating certain parts of the library to native C code. This library allows for PSD.rb to function as a pure Ruby library, while allowing for optional native code speed improvements. It overwrites specific methods within PSD.rb transparently, so you can use PSD.rb like normal.
Currently, PSDNative replaces these sections of PSD.rb with native code:
* RGB processing
-* RLE decoding (disabled; needs optimization)
+* RLE decoding
## Installation
Add this line to your application's Gemfile:
@@ -20,9 +20,11 @@
Or install it yourself as:
$ gem install psd_native
## Usage
+
+Simply require `psd_native` instead of `psd`, and you're good to go.
``` ruby
require 'psd_native'
psd = PSD.new("path/to/file.psd")