From 92be203f2ac0fbad30ea9bbf795dc3c786db1549 Mon Sep 17 00:00:00 2001 From: kwantam Date: Tue, 14 Apr 2015 21:40:45 -0400 Subject: [PATCH] add readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..559fd27 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +Unicode character composition and decomposition utilities +as described in +[Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/). + +[![Build Status](https://travis-ci.org/unicode-rs/unicode-normalization.svg)](https://travis-ci.org/unicode-rs/unicode-normalization) + +```rust +extern crate unicode_normalization; + +use unicode_normalization::char::compose; +use unicode_normalization::str::UnicodeNormalization; + +fn main() { + assert_eq!(compose('A','\u{30a}'), Some('Å')); + + let s = "ÅΩ"; + let c = UnicodeNormalization::nfc_chars(s).collect::(); + assert_eq!(c, "ÅΩ"); +} +``` + +# crates.io + +You can use this package in your project by adding the following +to your `Cargo.toml`: + +```toml +[dependencies] +unicode-normalization = "0.0.1" +```