summaryrefslogtreecommitdiffstats
path: root/third_party/rust/unicode-normalization/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/unicode-normalization/README.md')
-rw-r--r--third_party/rust/unicode-normalization/README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/third_party/rust/unicode-normalization/README.md b/third_party/rust/unicode-normalization/README.md
new file mode 100644
index 0000000000..35030e360d
--- /dev/null
+++ b/third_party/rust/unicode-normalization/README.md
@@ -0,0 +1,39 @@
+# unicode-normalization
+
+[![Build Status](https://travis-ci.org/unicode-rs/unicode-normalization.svg)](https://travis-ci.org/unicode-rs/unicode-normalization)
+[![Docs](https://docs.rs/unicode-normalization/badge.svg)](https://docs.rs/unicode-normalization/)
+
+Unicode character composition and decomposition utilities
+as described in
+[Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/).
+
+This crate requires Rust 1.36+.
+
+```rust
+extern crate unicode_normalization;
+
+use unicode_normalization::char::compose;
+use unicode_normalization::UnicodeNormalization;
+
+fn main() {
+ assert_eq!(compose('A','\u{30a}'), Some('Å'));
+
+ let s = "ÅΩ";
+ let c = s.nfc().collect::<String>();
+ 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.1.22"
+```
+
+## `no_std` + `alloc` support
+
+This crate is completely `no_std` + `alloc` compatible. This can be enabled by disabling the `std` feature, i.e. specifying `default-features = false` for this crate on your `Cargo.toml`.