strapi-relation-names 0.0.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -92,14 +92,30 @@ After saving the settings, the Strapi Admin reloads automatically so open Conten
92
92
 
93
93
  ---
94
94
 
95
- ## ⚙️ Templates
95
+ ## ⚙️ Configuration
96
96
 
97
- Templates use direct field placeholders:
97
+ Possible configuration keys are listed below; omitted keys keep the plugin defaults.
98
98
 
99
- ```text
100
- {fieldName}
99
+ | Key | Description | Possible values |
100
+ | ------------- | ----------------------------------------------------------------------------------------------- | --------------- |
101
+ | `collections` | Limit relation names to the listed collection and single type UIDs. Leave empty to include all. | `string[]` |
102
+
103
+ Example:
104
+
105
+ ```javascript
106
+ // config/plugins.{js,ts}
107
+ 'strapi-relation-names': {
108
+ enabled: true,
109
+ config: {
110
+ collections: ['api::article.article', 'api::author.author'],
111
+ },
112
+ },
101
113
  ```
102
114
 
115
+ ---
116
+
117
+ ## ⚙️ Templates
118
+
103
119
  Multiple placeholders can be combined:
104
120
 
105
121
  ```text
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "author": "Christoph Tupi <christoph.tupi@gmail.com>",
6
6
  "keywords": [],
7
7
  "type": "commonjs",
8
- "version": "0.0.0",
8
+ "version": "1.0.0",
9
9
  "strapi": {
10
10
  "kind": "plugin",
11
11
  "name": "strapi-relation-names",