Current File : /www/varak.net/wiki.varak.net/extensions/VisualEditor/lib/ve/lib/unicodejs/README.md
[](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://git.wikimedia.org/git/unicodejs.git`.
Versioning
----------
We use the Semantic Versioning guidelines as much as possible.
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://bugzilla.wikimedia.org/enter_bug.cgi?product=Utilities&component=UnicodeJS)!
Release
----------
Release process:
<pre lang="bash">
$ cd path/to/unicodejs/
$ git remote update
$ git checkout -b release -t origin/master
# Ensure tests pass
$ npm install && npm test
# Avoid using "npm version patch" because that creates
# both a commit and a tag, and we shouldn't tag until after
# the commit is merged.
# Update release notes
# Copy the resulting list into a new section on History.md
$ git log --format='* %s (%aN)' --no-merges --reverse v$(node -e 'console.log(JSON.parse(require("fs").readFileSync("package.json")).version);')...HEAD
$ edit History.md
# Update the version number
$ edit package.json
$ git add -p
$ git commit -m "Tag vX.X.X"
$ git review
# After merging:
$ git remote update
$ git checkout origin/master
$ git tag "vX.X.X"
$ git push --tags
$ npm publish
</pre>
Mini Shell