Skip to content

Commit

Permalink
Document README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hakatashi committed Sep 18, 2014
1 parent 3fcf6a6 commit b47c135
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ $RECYCLE.BIN/

# sources and data
sources
data/*.json

# JSDoc generated files
out
Expand Down
10 changes: 0 additions & 10 deletions Makefile

This file was deleted.

13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,29 @@ IVS.js

Node.js module that supplies mutual IVS conversion between Adobe-Japan and Hanyo-denshi(Moji_Joho).

This package includes database for mutual conversion of IVS,
which is generated from [GlyphWiki](http://glyphwiki.org/)'s aliasing information.

## Install

npm install ivs

## Use

var IVS = require('ivs');
var ivs = new IVS(function () {
ivs.HD('葛󠄁飾󠄀区󠄀'); // -> '葛󠄃飾󠄂区󠄀'
});

## Usage

new IVS(callback)
-----------------------------

Constructor.

**callback**: Function(error), called when IVS converter is ready.

forEachKanji(string, callback)
-----------------------------
Execute function for each Kanji and IVS (if exists) in given string
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
},
"main": "index.js",
"scripts": {
"test": "make test",
"build": "make build --always-make"
"test": "grunt test",
"build": "grunt build"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit b47c135

Please sign in to comment.