Comparing version 1.4.0 to 1.5.0
@@ -1,7 +0,7 @@ | ||
# Contributing to `full-icu-npm` | ||
# Contributing to `full-icu` | ||
## What is `full-icu-npm`? | ||
## What is `full-icu`? | ||
International Components for Unicode (ICU) is an open-source project of mature C/C++ and Java libraries for Unicode support, software internationalization, and software globalization. ICU is widely portable to many operating systems and environments, and is an initiative of the [Unicode Consortium](https://home.unicode.org/). | ||
Node.js uses ICU to implement these features in native C/C++ code. The full ICU data set is provided in Node.js by default, and this module is how it is provisioned to node. It's resulting npm package is published [here](https://www.npmjs.com/package/full-icu). | ||
Node.js uses ICU to implement these features in native C/C++ code. The full ICU data set is provided in Node.js by default, and this module is how it is provisioned to node. It's resulting npm package is published [here](https://www.npmjs.com/package/full-icu). | ||
@@ -15,3 +15,3 @@ **We are thankful for Your interest in contributing to this effort!** | ||
For more information on the Node.js Code of Conduct please review these [policy details](https://github.com/nodejs/node/blob/master/doc/guides/contributing/code-of-conduct.md). | ||
For more information on the Node.js Code of Conduct please review these [policy details](https://github.com/nodejs/node/blob/HEAD/doc/guides/contributing/code-of-conduct.md). | ||
@@ -18,0 +18,0 @@ ## Developer's Certificate of Origin 1.1 |
{ | ||
"name": "full-icu", | ||
"version": "1.4.0", | ||
"version": "1.5.0", | ||
"description": "install 'full-icu' data for your current node", | ||
@@ -22,6 +22,6 @@ "scripts": { | ||
"type": "git", | ||
"url": "https://github.com/icu-project/full-icu-npm.git" | ||
"url": "https://github.com/nodejs/full-icu-npm.git" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/unicode-org/full-icu-npm/issues" | ||
"url": "https://github.com/nodejs/full-icu-npm/issues" | ||
}, | ||
@@ -28,0 +28,0 @@ "dependencies": { |
@@ -94,2 +94,2 @@ // Copyright (C) 2015 IBM Corporation and Others. All Rights Reserved. | ||
} | ||
console.log('News: Please see https://github.com/icu-project/full-icu-npm/issues/6') | ||
console.log('News: Please see https://github.com/nodejs/full-icu-npm/issues/6') |
@@ -1,7 +0,39 @@ | ||
# full-icu-npm | ||
# full-icu | ||
Install full ICU data from GitHub or npm | ||
Install full ICU (Internationalization) data from GitHub or npm for Node.js. | ||
### What is this and why would I use it? | ||
Importing this package does not have any useful effect, see below. | ||
Originally, Node.js did not come with information for all of the world’s languages. | ||
The default build mode was “small-icu” which means English-only, saving about 50% of | ||
the total Node.js download footprint. | ||
Since Node.js 13, full ICU data has been the default for Node.js. | ||
So this module is only helpful for older Node.js versions, or custom | ||
builds which specify small-icu. | ||
This module does not add any internationalization capabilities to Node.js, | ||
but it can provide a convenient way of loading the data. | ||
Please see [“providing ICU data at runtime”](https://nodejs.org/api/intl.html#providing-icu-data-at-runtime) in the Node.js docs for more information. | ||
### Am I using `small-icu`? | ||
Let's find out: | ||
```shell | ||
$ node -p 'process.config.variables.icu_small' | ||
true | ||
``` | ||
If you see `false` here, you aren't using small ICU and **this package won’t do | ||
anything useful for you,** although it is harmless. | ||
### To use | ||
First, you must have a Node.js that is configured for `small-icu`. | ||
See above. | ||
`npm install full-icu` | ||
@@ -24,2 +56,5 @@ | ||
Note that this is only packaging and build metadata. | ||
For Internationalization API, see [Intl](https://nodejs.org/api/intl.html). | ||
`require('full-icu')` returns a few properties: | ||
@@ -63,3 +98,3 @@ | ||
This repository is subject to the terms under the [Node.js license](https://github.com/nodejs/node/blob/master/LICENSE). Some usage of this data is governed by the [Unicode Terms of Use](http://www.unicode.org/copyright.html), which is included in the [unicode-license.txt](./unicode-license.txt) | ||
This repository is subject to the terms under the [Node.js license](https://github.com/nodejs/node/blob/HEAD/LICENSE). Some usage of this data is governed by the [Unicode Terms of Use](http://www.unicode.org/copyright.html), which is included in the [unicode-license.txt](./unicode-license.txt) | ||
@@ -66,0 +101,0 @@ ## COPYRIGHT |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
32940
22
104