Skip to content

Commit

Permalink
docs(npm): fix package name
Browse files Browse the repository at this point in the history
  • Loading branch information
noomorph authored Feb 12, 2022
1 parent 1476cf1 commit 0677601
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions packages/npm/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @interslavic/dictionary
# dictionary-isv

Interslavic spelling dictionary in UTF-8.

Expand All @@ -12,7 +12,7 @@ Generated by [@orlean-git's Python package in this repository](../hunspell).
[npm][]:

```sh
npm install @interslavic/dictionary
npm install dictionary-isv
```

## Use
Expand All @@ -22,24 +22,24 @@ The package exports multiple dictionaries:
* **combined** (the default one), which can check Interslavic texts written
both in Latin and Cyrillic scripts:
```js
var dictionary = require('@interslavic/dictionary');
var dictionary = require('dictionary-isv');
// or the aliased version:
var dictionary = require('@interslavic/dictionary/combined');
var dictionary = require('dictionary-isv/combined');
```
* **etymological**, not recommended for daily use, but useful for flavorizing
texts to specific Slavic target languages and also for dictionary development:
```
var dictionary = require('@interslavic/dictionary/etymological');
```js
var dictionary = require('dictionary-isv/etymological');
```
* **Latin-only**, a lightweight and a faster alternative to the default combined
dictionary which works only for Interslavic written in Latin script:
```
var dictionary = require('@interslavic/dictionary/latin');
```js
var dictionary = require('dictionary-isv/latin');
```
* **Cyrillic-only**, a lightweight and a faster alternative to the default combined
dictionary which works only for Interslavic written in Cyrillic script:
```
var dictionary = require('@interslavic/dictionary/cyrillic');
```js
var dictionary = require('dictionary-isv/cyrillic');
```

Every exported module is an asynchronous function with a callback, e.g.:
Expand All @@ -48,7 +48,7 @@ Every exported module is an asynchronous function with a callback, e.g.:
dictionary(function (err, result) {
console.log(err || result)
// -> {dic: <Buffer>, aff: <Buffer>}
})
});
```

where:
Expand All @@ -60,7 +60,7 @@ Also, you can directly load the files, using the respective IETF BCP 47 language

```js
var path = require('path')
var base = path.dirname(require.resolve('@interslavic/dictionary'));
var base = path.dirname(require.resolve('dictionary-isv'));

// combined:
fs.readFileSync(path.join(base, 'dict/art-x-interslv.dic'), 'utf-8')
Expand Down

0 comments on commit 0677601

Please sign in to comment.