diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..df9beba --- /dev/null +++ b/Makefile @@ -0,0 +1,3 @@ + +test: + @mocha -R spec tests/test.js diff --git a/README.md b/README.md index 296bb24..99f4323 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,35 @@ # JavaScript 拼音 -用 Javascript 将汉字转为拼音,方便汉字注音、排序。 +将汉语转为拼音。可以用于汉字注音、排序、检索。 -支持将汉字转换为多种不同风格的拼音。 +## 特性 -## 安装 +* 根据词组智能匹配最正确的拼音。 +* 支持多音字。 +* 简单的繁体支持。 +* 支持多种不同拼音风格。 -暂时未托管到 npmjs.org +## 安装 - git clone git://github.com/hotoo/node-pinyin.git - npm install ./node-pinyin +``` +npm install pinyinjs +``` ## 用法 - var pinyin = require("pinyin"); - - console.log(pinyin("中心")); // [ [ 'zhōng' ], [ 'xīn' ] ] - console.log(pinyin("中心", { - heteronym: true // 启用多音字模式 - })); // [ [ 'zhōng', 'zhòng' ], [ 'xīn' ] ] - console.log(pinyin("中心", { - style: pinyin.STYLE_INITIALS, // 设置拼音风格 - heteronym: true - })); // [ [ 'zh' ], [ 'x' ] ] - +```js +var pinyin = require("pinyin"); + +console.log(pinyin("中心")); // [ [ 'zhōng' ], [ 'xīn' ] ] +console.log(pinyin("中心", { + heteronym: true // 启用多音字模式 +})); // [ [ 'zhōng', 'zhòng' ], [ 'xīn' ] ] +console.log(pinyin("中心", { + style: pinyin.STYLE_INITIALS, // 设置拼音风格 + heteronym: true +})); // [ [ 'zh' ], [ 'x' ] ] +``` ## API diff --git a/bin/cli.js b/bin/cli.js deleted file mode 100644 index 908ba84..0000000 --- a/bin/cli.js +++ /dev/null @@ -1 +0,0 @@ -#!/usr/bin/env node diff --git a/bin/pinyin b/bin/pinyin new file mode 100755 index 0000000..7938db9 --- /dev/null +++ b/bin/pinyin @@ -0,0 +1,30 @@ +#!/usr/bin/env node +var commander = require('commander'); +//require('colors'); +var pinyin = require("../src/pinyin"); + +commander. + version(require('../package').version). + usage('[options] 汉字'). + option('-v, --version', 'output the version number'). + option('-s, --style