You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
<divalign="center">
2
2
<h1>Strapi config-sync plugin</h1>
3
3
4
-
<pstyle="margin-top: 0;">CLI & GUI for syncing config data across environments.</p>
4
+
<pstyle="margin-top: 0;">This plugin is a multi-purpose tool to manage your Strapi database records through JSON files. Mostly used for automated deployment, automated tests and data sharing for collaboration purposes.</p>
-**GUI** (Settings page for syncing the config in Strapi admin)
26
26
-**Partial sync** (Import or export only specific portions of config)
27
27
-**Custom types** (Include your custom collection types in the sync process)
28
+
-**Import on bootstrap** (Easy automated deployment with `importOnBootstrap`)
28
29
-**Exclusion** (Exclude single config entries or all entries of a given type)
29
30
-**Diff viewer** (A git-style diff viewer to inspect the config changes)
30
31
@@ -246,6 +247,8 @@ These 4 types are by default registered in the sync process.
246
247
247
248
Your custom types can be registered through the `customTypes` plugin config. This is a setting that can be set in the `config/plugins.js` file in your project.
248
249
250
+
_Read more about the `config/plugins.js` file [here](#-settings)._
251
+
249
252
You can register a type by giving the `customTypes` array an object which contains at least the following 3 properties:
250
253
251
254
```
@@ -258,8 +261,6 @@ customTypes: [{
258
261
259
262
_The example above will register the Strapi webhook type._
260
263
261
-
_Read more about the `config/plugins.js` file [here](#-settings)._
262
-
263
264
#### Config name
264
265
265
266
The name of the config type. This value will be used as the first part of the filename for all config of this type. It should be unique from the other types and is preferably written in kebab-case.
0 commit comments