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: Update readme

pull/28/head
Boaz Poolman 2021-11-21 21:44:30 +01:00
parent b0f709695b
commit c7559082c3
1 changed files with 2 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -24,10 +24,9 @@
- **CLI** (`config-sync` CLI for syncing the config from the command line) - **CLI** (`config-sync` CLI for syncing the config from the command line)
- **GUI** (Settings page for syncing the config in Strapi admin) - **GUI** (Settings page for syncing the config in Strapi admin)
- **Partial sync** (Import or export only specific portions of config) - **Partial sync** (Import or export only specific portions of config)
- **Exclude configs** (Exclude specific config that contains sensitive info)
## ⏳ Setup ## ⏳ Installation
### Installation
Install the plugin in your Strapi project. Install the plugin in your Strapi project.
@ -38,8 +37,6 @@ yarn add strapi-plugin-config-sync
# using npm # using npm
npm install strapi-plugin-config-sync --save npm install strapi-plugin-config-sync --save
``` ```
### Configuration
Add the export path to the `watchIgnoreFiles` list in the `config/admin.js` file. Add the export path to the `watchIgnoreFiles` list in the `config/admin.js` file.
This way your app won't reload when you export the config in development. This way your app won't reload when you export the config in development.
@ -54,8 +51,6 @@ This way your app won't reload when you export the config in development.
], ],
### Rebuilding
After successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run: After successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run:
```bash ```bash