Go to file
Jari Bakken 52c8bbc838 Get rid of iconv, collation now is reasonably fast 2010-05-11 00:21:18 +02:00
benchmark Yet another rename (more consistent with other FFI projects) 2010-05-10 20:28:20 +02:00
lib Get rid of iconv, collation now is reasonably fast 2010-05-11 00:21:18 +02:00
spec Cross-platform way of fetching locales 2010-05-10 23:18:25 +02:00
.document Initial commit to icu-chardet-ffi. 2010-05-09 19:04:44 +02:00
.gitignore Initial commit to icu-chardet-ffi. 2010-05-09 19:04:44 +02:00
LICENSE Initial commit to icu-chardet-ffi. 2010-05-09 19:04:44 +02:00
README.rdoc Yet another rename (more consistent with other FFI projects) 2010-05-10 20:28:20 +02:00
Rakefile Yet another rename (more consistent with other FFI projects) 2010-05-10 20:28:20 +02:00
VERSION Version bump to 0.0.3 2010-05-09 22:30:45 +02:00

README.rdoc

= ffi-icu

Simple FFI wrappers for things I need from ICU.

= Dependencies

ICU - you might need to hack the ffi_lib call to make it work. Please send a patch if you do!

= Features

== Character Encoding Detection

=== Examples:

  match = ICU::CharDet.detect(str)
  match.name       # => "UTF-8"
  match.confidence # => 80

or

  detector = ICU::CharDet::Detector.new
  detector.detect(str)
  detector.close

=== Why not just use rchardet?

* this is faster
* rchardet does not work well on 1.9
* none of the rchardet forks claiming to work on 1.9 actually does

== Locale Sensitive Collation

Todo.

= Tested on:

Platforms:

* OS X 10.6
* Debian Linux
* Arch Linux

Rubies:

* MRI 1.9.1
* MRI 1.8.7

YMMV.

== Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2010 Jari Bakken. See LICENSE for details.