README.md in unicode-x-1.4.1 vs README.md in unicode-x-11.0.0

- old
+ new

@@ -1,27 +1,35 @@ -# Unicode::X [![[version]](https://badge.fury.io/rb/unicode-x.svg)](https://badge.fury.io/rb/unicode-x) +# Unicode::X 11 [![[version]](https://badge.fury.io/rb/unicode-x.svg)](https://badge.fury.io/rb/unicode-x) -A collection of specific micro libraries providing data and algorithms that might be handy when working with Unicode characters in Ruby: +**Unicodex** is a collection of choose-what-you-need style Unicode libraries for Ruby. +## Libraries + Library | Info ------------------------|------------------------------------------------- -[unicode-blocks](https://github.com/janlelis/unicode-blocks) | Blocks -[unicode-categories](https://github.com/janlelis/unicode-categories) | General Categories -[unicode-confusable](https://github.com/janlelis/unicode-confusable) | Confusable detection -[unicode-emoji](https://github.com/janlelis/unicode-emoji) | Emoji data and regex +[unicode-blocks](https://github.com/janlelis/unicode-blocks) | Data about blocks +[unicode-categories](https://github.com/janlelis/unicode-categories) | Data about general categories +[unicode-confusable](https://github.com/janlelis/unicode-confusable) | Detect confusable characters +[unicode-emoji](https://github.com/janlelis/unicode-emoji) | Emoji list and regex [unicode-display_width](https://github.com/janlelis/unicode-display_width) | Monospace character width -[unicode-name](https://github.com/janlelis/unicode-name) | Unicode codepoint name/alias/label -[unicode_normalize](https://github.com/ruby/ruby/blob/trunk/lib/unicode_normalize/normalize.rb) | Unicode normalization (from **stdlib**) -[unicode-numeric_value](https://github.com/janlelis/unicode-numeric_value) | Convert a Unicode character into its numeric value -[unicode-scripts](https://github.com/janlelis/unicode-scripts) | Scripts and Script_Extensions -[unicode-sequence_name](https://github.com/janlelis/unicode-sequence_name) | Codepoint sequence names -[unicode-types](https://github.com/janlelis/unicode-types) | Basic codepoint types +[unicode-name](https://github.com/janlelis/unicode-name) | Codepoint names and labels +[unicode-numeric_value](https://github.com/janlelis/unicode-numeric_value) | Retrieve values of numerical codepoints +[unicode-scripts](https://github.com/janlelis/unicode-scripts) | Data about scripts / script extensions +[unicode-sequence_name](https://github.com/janlelis/unicode-sequence_name) | Names of codepoint sequences +[unicode-types](https://github.com/janlelis/unicode-types) | Basic type of codepoints -## Setup +## Collection -Add to Gemfile: +You can get all by libraries at once by adding to your `Gemfile`: ```ruby gem 'unicode-x' ``` -All gems can also be installed standalone, if you only need certain features. The Unicode index data in most of the gems is generated using [unicoder](https://github.com/janlelis/unicoder). +### Versioning Policy + +Beginning with version 11, `Unicode::X`'s major version is synced to Unicode's. It will require the latest version of the micro libraries that come with the specified Unicode version. + +## Also See + +- [Introduction to Unicode in Ruby](https://idiosyncratic-ruby.com/66-ruby-has-character.html) (blog post) +- [unicode_normalize](https://github.com/ruby/ruby/blob/trunk/lib/unicode_normalize/normalize.rb): Unicode normalization included in standard library \ No newline at end of file