diff --git a/README.md b/README.md index b8238cb..be3c128 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# NPM pinyin2ipa +# pinyin2ipa [![dependencies Status](https://david-dm.org/Connum/npm-pinyin2ipa/status.svg)](https://david-dm.org/Connum/npm-pinyin2ipa) [![devDependencies Status](https://david-dm.org/Connum/npm-pinyin2ipa/dev-status.svg)](https://david-dm.org/Connum/npm-pinyin2ipa?type=dev) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) @@ -8,6 +8,8 @@ Converts Mandarin Chinese Pinyin notation to IPA (International Phonetic Alphabe # Installation `npm install pinyin2ipa` +or use the files in `/dist` or from the [releases](https://github.com/Connum/npm-pinyin2ipa/releases) for direct in-browser usage. + # Usage and examples ```js const pinyin2ipa = require('pinyin2ipa').default