From 30c678e77068a89c83d7270c6e7c0806127b5c3b Mon Sep 17 00:00:00 2001 From: Boaz Poolman Date: Thu, 27 Jan 2022 16:04:05 +0100 Subject: [PATCH] docs: Update readme --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf27b25..be7dd8d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

Strapi config-sync plugin

-

CLI & GUI for syncing config data across environments.

+

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.

@@ -25,6 +25,7 @@ - **GUI** (Settings page for syncing the config in Strapi admin) - **Partial sync** (Import or export only specific portions of config) - **Custom types** (Include your custom collection types in the sync process) +- **Import on bootstrap** (Easy automated deployment with `importOnBootstrap`) - **Exclusion** (Exclude single config entries or all entries of a given type) - **Diff viewer** (A git-style diff viewer to inspect the config changes) @@ -246,6 +247,8 @@ These 4 types are by default registered in the sync process. 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. +_Read more about the `config/plugins.js` file [here](#-settings)._ + You can register a type by giving the `customTypes` array an object which contains at least the following 3 properties: ``` @@ -258,8 +261,6 @@ customTypes: [{ _The example above will register the Strapi webhook type._ -_Read more about the `config/plugins.js` file [here](#-settings)._ - #### Config name 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.