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

Comparing version 1.3.0 to 1.3.1

package.json

 {
   "name": "@cspell/dict-de-ch",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Swiss German dictionary for CSpell.",
@@ -52,3 +52,3 @@ "publishConfig": {
   },
-  "gitHead": "bf836f3c1ffa58ecaa9cefa238857d09c49f7682"
+  "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
 }

README.md

@@ -7,29 +7,129 @@ # CSpell Swiss German Dictionary
 
-## Installation
+<!--- @@inject: ../../static/requirements.md --->
 
-Global Install and add to CSpell global settings.
+## Requirements
 
+| Tool                                                                                                                                 | Version |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
+| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 8`  |
+| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4`  |
+
+<!--- @@inject-end: ../../static/requirements.md --->
+
+<!--- @@inject: ./static/install.md --->
+
+## Local Installation
+
 ```sh
-npm install -g @cspell/dict-de-ch
-cspell link add @cspell/dict-de-ch
+npm install -D @cspell/dict-de-ch
 ```
 
-## Uninstall from CSpell
+## Configuration
 
-```sh
-cspell link remove @cspell/dict-de-ch
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["@cspell/dict-de-ch/cspell-ext.json"],
+  "cSpell.language": "de, de_CH",
+}
 ```
 
-## Manual Installation
+</details>
 
-The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
+<details>
+<summary>CSpell Settings `cspell.json`</summary>
 
-```javascript
+**`cspell.json`**
+
+```jsonc
 {
-    // …
-    "import": ["@cspell/dict-de-ch/cspell-ext.json"],
-    // …
+  "import": ["@cspell/dict-de-ch/cspell-ext.json"],
+  "language": "de, de_CH",
 }
 ```
 
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.config.yaml`</summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - '@cspell/dict-de-ch/cspell-ext.json'
+language: de, de_CH
+```
+
+</details>
+
+## CDN Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-de-ch@latest/cspell-ext.json/cspell-ext.json"],
+  "cSpell.language": "de, de_CH",
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.json`</summary>
+
+**`cspell.json`**
+
+```jsonc
+{
+  "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-de-ch@latest/cspell-ext.json/cspell-ext.json"],
+  "language": "de, de_CH",
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.config.yaml`</summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - https://cdn.jsdelivr.net/npm/@cspell/dict-de-ch@latest/cspell-ext.json/cspell-ext.json
+language: de, de_CH
+```
+
+</details>
+
+<!--- @@inject-end: ./static/install.md --->
+
+<!--- @@inject: ../../static/contributing.md --->
+
+## Contributing
+
+Please help correct any mistakes in the dictionaries.
+
+See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
+
+Special thanks to all of our amazing contributors!
+
+### Dictionary Development
+
+See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
+
+<!--- @@inject-end: ../../static/contributing.md --->
+
 ## Resources
@@ -39,2 +139,16 @@
 
-- https://github.com/wooorm/dictionaries/tree/main#readme
+- [tree/main#readme](https://github.com/wooorm/dictionaries/tree/main#readme)
+
+<!--- @@inject: ../../static/footer.md --->
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!--- @@inject-end: ../../static/footer.md --->

No alert changes

Improved metrics

Total package byte prevSize

842010

0.32%

Number of lines in readme file

153

292.31%

No dependency changes