1
0
mirror of https://github.com/chanind/hanzi-writer-data.git synced 2025-06-17 01:09:56 +08:00

readme and package.json version bump

This commit is contained in:
David Chanin 2018-02-04 14:41:27 +08:00
parent e5cdb78777
commit a089d6c5c2
2 changed files with 3 additions and 1 deletions

View File

@ -6,6 +6,8 @@ This is the character data used by [Hanzi Writer](https://github.com/chanind/han
- This allows users who wish to import character data in NPM to do so without forcing everyone to download the character data along with Hanzi Writer.
- Publishing on NPM makes this data available on the [jsdelivr CDN](https://www.jsdelivr.com/package/npm/hanzi-writer-data), so data can be loaded via, for instance, https://cdn.jsdelivr.net/npm/hanzi-writer-data@latest/我.json.
Check out [https://chanind.github.io/hanzi-writer](chanind.github.io/hanzi-writer) for more info about Hanzi Writer.
## Usage
By default Hanzi Writer will automatically load this character data from the jsdelivr CDN when needed, so most users don't need to worry about loading this data explicity. However, loading this data explicitly can allow Hanzi Writer to work offline which is great for mobile apps. Also, if you know in advance which characters Hanzi Writer should display you can preload the data and avoid needing to make a web request at all, which is a nice speed boost. The easiest way to load Hanzi Writer character data is via npm:

View File

@ -1,6 +1,6 @@
{
"name": "hanzi-writer-data",
"version": "0.0.1",
"version": "1.0.0",
"author": "David Chanin <chanindav@gmail.com> (https://chanind.github.io/hanzi-writer)",
"description": "The character data used by Hanzi Writer. This data is derived from the Make Me a Hanzi project.",
"repository": "chanind/hanzi-writer-data",