@cspell/dict-django - npm Package Compare versions

Comparing version 4.1.4 to 4.1.5

LICENSE

@@ -5,3 +5,3 @@ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 Copyright (c) 2017-2020 Renaud Canarduck <[e-mail]>
-Copyright (c) 2017-2020 Jason Dent <[e-mail]>
+Copyright (c) 2017-2025 Street Side Software <[e-mail]>
 
@@ -8,0 +8,0 @@ Everyone is permitted to copy and distribute verbatim or modified

package.json

 {
   "name": "@cspell/dict-django",
-  "version": "4.1.4",
+  "version": "4.1.5",
   "description": "Django dictionary for cspell.",
@@ -45,3 +45,3 @@ "publishConfig": {
   ],
-  "gitHead": "588365f8c00b710c7d9eb46db5477f6db48a920d"
+  "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
 }

README.md

@@ -7,2 +7,4 @@ # CSpell Django Dictionary
 
+<!--- @@inject: ../../static/requirements.md --->
+
 ## Requirements
@@ -12,35 +14,81 @@
 | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
-| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 6`  |
-| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 2`  |
+| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 8`  |
+| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4`  |
 
-## Installation
+<!--- @@inject-end: ../../static/requirements.md --->
 
-Global Install and add to cspell global settings.
+<!--- @@inject: ./static/install.md --->
 
-```sh
-npm install -g @cspell/dict-django
-cspell link add @cspell/dict-django
-```
+## Local Installation
 
-## Uninstall from cspell
+**This package is bundled with CSpell.**
 
-```sh
-cspell link remove @cspell/dict-django
+## Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.dictionaries": ["django"],
+}
 ```
 
-## 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-django/cspell-ext.json"],
-    // …
+  "dictionaries": ["django"],
 }
 ```
 
+</details>
+
+<details>
+<summary>CSpell Settings `cspell.config.yaml`</summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+dictionaries:
+  - django
+```
+
+</details>
+
+> [!NOTE]
+> **This package is bundled with CSpell.**
+
+<!--- @@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 --->
+
 ## Updating
 
-This dictionary is generated from django's official documentation index : https://docs.djangoproject.com/en/`VERSION`/genindex/.
+<!--- cspell:ignore genindex --->
+
+This dictionary is generated from django's official documentation index : [genindex/](https://docs.djangoproject.com/en/`VERSION`/genindex/).
 To update it, edit `update.py`to match wanted django's `VERSION`, install requirements ([requests](http://docs.python-requests.org) and [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/)) and run the script :
@@ -53,12 +101,18 @@
 
-## Building
+## License
 
-Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
+WTFPL
 
-```sh
-npm run build
-```
+<!--- @@inject: ../../static/footer.md --->
 
-## License
+<br/>
 
-WTFPL
+---
+
+<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

41435

2.54%

Number of lines in readme file

116

87.1%

No dependency changes