ambiser
/
strapi-plugin-config-sync
mirror of https://github.com/boazpoolman/strapi-plugin-config-sync
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Fix issue in readme

pull/106/head
Boaz Poolman 2023-10-14 17:49:31 +02:00
parent 4581bf1751
commit a153f87fba
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -346,14 +346,6 @@ Example:
> `required:` NO | `type:` array > `required:` NO | `type:` array
#### JSON fields
This property can accept an array of field names from the type. It is meant to specify the JSON fields on the type so the plugin can better format the field values when calculating the config difference.
###### Key: `jsonFields`
> `required:` NO | `type:` array
#### Components #### Components
This property can accept an array of component names from the type. Strapi Components can be included in the export/import process. With "." nested components can also be included in the process. This property can accept an array of component names from the type. Strapi Components can be included in the export/import process. With "." nested components can also be included in the process.
@ -364,11 +356,19 @@ customTypes: [{
uid: 'name', uid: 'name',
components: ['ParentComponentA', 'ParentComponentA.ChildComponent', 'ParentComponentB'] components: ['ParentComponentA', 'ParentComponentA.ChildComponent', 'ParentComponentB']
}], }],
```
###### Key: `components` ###### Key: `components`
> `required:` NO | `type:` array > `required:` NO | `type:` array
#### JSON fields
This property can accept an array of field names from the type. It is meant to specify the JSON fields on the type so the plugin can better format the field values when calculating the config difference.
###### Key: `jsonFields`
> `required:` NO | `type:` array
## 🔍 Naming convention ## 🔍 Naming convention
All the config files written in the sync directory have the same naming convention. It goes as follows: All the config files written in the sync directory have the same naming convention. It goes as follows: