Skip to content

Commit 30c678e

Browse files
committed
docs: Update readme
1 parent 5b1a7bc commit 30c678e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<h1>Strapi config-sync plugin</h1>
33

4-
<p style="margin-top: 0;">CLI & GUI for syncing config data across environments.</p>
4+
<p style="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>
55

66
<p>
77
<a href="https://www.npmjs.org/package/strapi-plugin-config-sync">
@@ -25,6 +25,7 @@
2525
- **GUI** (Settings page for syncing the config in Strapi admin)
2626
- **Partial sync** (Import or export only specific portions of config)
2727
- **Custom types** (Include your custom collection types in the sync process)
28+
- **Import on bootstrap** (Easy automated deployment with `importOnBootstrap`)
2829
- **Exclusion** (Exclude single config entries or all entries of a given type)
2930
- **Diff viewer** (A git-style diff viewer to inspect the config changes)
3031

@@ -246,6 +247,8 @@ These 4 types are by default registered in the sync process.
246247

247248
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.
248249

250+
_Read more about the `config/plugins.js` file [here](#-settings)._
251+
249252
You can register a type by giving the `customTypes` array an object which contains at least the following 3 properties:
250253

251254
```
@@ -258,8 +261,6 @@ customTypes: [{
258261

259262
_The example above will register the Strapi webhook type._
260263

261-
_Read more about the `config/plugins.js` file [here](#-settings)._
262-
263264
#### Config name
264265

265266
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

Comments
 (0)