diff --git a/.gitignore b/.gitignore index 331eec8..6cb0260 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ vendor/ composer.lock *.min.* var +/.vscode/ +/.idea/ diff --git a/README.md b/README.md index 6a976a1..b6453c0 100644 --- a/README.md +++ b/README.md @@ -30,3 +30,23 @@ You can also provide a destination path (ie. if your `empty` directory is not in * `{LNAME}` will be replaced byt the lowercased name, * `{UNAME}` will be replaced by the uppercased name, * `{YEAR}` will be replaced by the current year. + +## Updating Your Plugin + +To import the changes made to the _pluginsGLPI empty_ template into your project, +we recommend using [_template-sync_](https://github.com/coopTilleuls/template-sync): + +1. Run the script to synchronize your project with the latest version of the skeleton: + + + + ```console + curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/pluginsGLPI/empty + ``` + + + +2. Resolve conflicts, if any +3. Run `git cherry-pick --continue` + +For more advanced options, refer to [the documentation of _template sync_](https://github.com/coopTilleuls/template-sync#template-sync).