[![NPM version](https://badge.fury.io/js/unicodejs.svg)](https://badge.fury.io/js/unicodejs)

UnicodeJS
=================

UnicodeJS is a JavaScript library for working with the Unicode standard.

Quick start
----------

This library is available as an [npm](https://npmjs.org/) package! Install it right away:
<pre lang="bash">
npm install unicodejs
</pre>

Or clone the repo, `git clone https://gerrit.wikimedia.org/r/unicodejs`.

Documentation
----------

The library provide methods for detecting **Word Boundaries** and **Grapheme Cluster Boundaries** as defined in the *[Text Segmentation specification](https://unicode.org/reports/tr29/)*

Full documentation is pubished at https://doc.wikimedia.org/unicodejs/master/.

Versioning
----------

We use the Semantic Versioning guidelines as much as possible; major versions reflect the version of Unicode we target.

Releases will be numbered in the following format:

`<major>.<minor>.<patch>`

For more information on SemVer, please visit http://semver.org/.

Bug tracker
-----------

Found a bug? Please report it in the [issue tracker](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?project=Utilities-UnicodeJS)!
