@cspell/dict-de-ch - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

src/hunspell/readme.md

+# dictionary-de-ch
+
+German (Switzerland) spelling dictionary.
+
+## What is this?
+
+This is a German (Switzerland) dictionary,
+generated by [`wooorm/dictionaries`][dictionaries] from
+[`j3e.de`][source],
+normalized and packaged so that it can be installed and used like other
+dictionaries.
+
+## When should I use this?
+
+You can use this package when integrating with tools that perform spell checking
+(such as [`nodehun`][nodehun], [`nspell`][nspell]) or when making such tools.
+
+## Install
+
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
+
+```sh
+npm install dictionary-de-ch
+```
+
+## Use
+
+```js
+import dictionaryDeCh from 'dictionary-de-ch'
+
+dictionaryDeCh(function (error, deCh) {
+  if (error) throw error
+  console.log(deCh)
+  // To do: use `deCh` somehow
+})
+```
+
+Yields:
+
+```js
+{dic: <Buffer>, aff: <Buffer>}
+```
+
+Where `dic` and `aff` are [`Buffer`][buffer]s for `index.dic` and `index.aff`
+respectively.
+
+## Examples
+
+See the [monorepo readme][dictionaries] for examples.
+
+## Types
+
+This package is typed with [TypeScript][].
+
+## Contribute
+
+See the [monorepo readme][dictionaries] for how to contribute.
+
+> 👉 **Note**: dictionaries are not maintained here.
+> Report spelling problems upstream ([`j3e.de`][source]).
+
+## License
+
+Dictionary and affix file: [(GPL-2.0 OR GPL-3.0)](https://github.com/wooorm/dictionaries/blob/main/dictionaries/de-CH/license).
+Rest: [MIT][] © [Titus Wormer][home].
+
+[hunspell]: https://hunspell.github.io
+
+[nodehun]: https://github.com/nathanjsweet/nodehun
+
+[nspell]: https://github.com/wooorm/nspell
+
+[macos]: https://github.com/wooorm/dictionaries#example-use-with-macos
+
+[source]: https://www.j3e.de/ispell/igerman98/index_en.html
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[dictionaries]: https://github.com/wooorm/dictionaries
+
+[mit]: https://github.com/wooorm/dictionaries/blob/main/license
+
+[buffer]: https://nodejs.org/api/buffer.html#buffer_buffer
+
+[home]: https://wooorm.com
+
+[typescript]: https://www.typescriptlang.org

src/README.md

+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.

package.json

 {
   "name": "@cspell/dict-de-ch",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Swiss German dictionary for CSpell.",
@@ -51,3 +51,3 @@ "publishConfig": {
   },
-  "gitHead": "7f0666a869ffeef44c755f30ec61b5a4043772d7"
+  "gitHead": "47a34789c05111e7b3cb693beb5d456bf25a0cb0"
 }

No alert changes

Improved metrics

Total package byte prevSize

885215

0.24%

Number of package files

8

33.33%

No dependency changes