* Update README.md
This commit is contained in:
Steven 2018-10-15 12:38:13 -05:00 коммит произвёл Mmdixon
Родитель 47a131f5e7
Коммит 3315afd5e8
1 изменённых файлов: 5 добавлений и 5 удалений

Просмотреть файл

@ -20,7 +20,7 @@ Current pre-built binaries offered to save the trouble of compiling the source l
(Run `node -p "process.versions.modules"` to see which Node-ABI in use.)
# Getting Started
This repository consists of TypeScript and native dependencies built with `node-gyp`. See `package.json` for various scripts for the developement process.
This repository consists of TypeScript and native dependencies built with `node-gyp`. See `package.json` for various scripts for the development process.
For first time building remember to `npm install`
@ -43,7 +43,7 @@ __EnPronouncer__ Pronounces a string, as a General English speaker, into its IPA
__matchers__ module:
* __FuzzyMatcher__ Main use case for this library. Returns matches against a list of targets for a given query. The comparisions are not remembered and therefore better for one-off use cases.
* __FuzzyMatcher__ Main use case for this library. Returns matches against a list of targets for a given query. The comparisons are not remembered and therefore better for one-off use cases.
* __AcceleratedFuzzyMatcher__ Same interface as `FuzzyMatcher` but the list of targets are precomputed, so beneficial for multiple queries at the cost of a higher initialization time.
@ -172,7 +172,7 @@ JOBS=X npm run build
## Test
```py
# Requires native depedencies built, but TypeScript transpiling not required.
# Requires native dependencies built, but TypeScript transpiling not required.
npm test
```
@ -189,9 +189,9 @@ npm run release
```
## Deployment/Upload
Note that the .js library code and native dependencies will be deployed separately. Npm regsitries will be used for the .js code, `node-pre-gyp` will be used for prebuilt dependencies while falling back to building on the client.
Note that the .js library code and native dependencies will be deployed separately. Npm registries will be used for the .js code, `node-pre-gyp` will be used for prebuilt dependencies while falling back to building on the client.
```py
# Pushes pack to npmjs.com or a private registry if a .npmrc exisits.
# Pushes pack to npmjs.com or a private registry if a .npmrc exists.
npm publish
```
```py