Skip to content

Commit 8c19c1a

Browse files
authored
chore: Add documentation on how to update the plugin (#55)
* chore: Add documentation on how to update the plugin * add to gitignore ide folders * style: remove linter
1 parent e6c2630 commit 8c19c1a

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ vendor/
55
composer.lock
66
*.min.*
77
var
8+
/.vscode/
9+
/.idea/

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,19 @@ You can also provide a destination path (ie. if your `empty` directory is not in
3030
* `{LNAME}` will be replaced byt the lowercased name,
3131
* `{UNAME}` will be replaced by the uppercased name,
3232
* `{YEAR}` will be replaced by the current year.
33+
34+
## Updating Your Plugin
35+
36+
To import the changes made to the _pluginsGLPI empty_ template into your project,
37+
we recommend using [_template-sync_](https://github.com/coopTilleuls/template-sync):
38+
39+
1. Run the script to synchronize your project with the latest version of the skeleton:
40+
41+
```console
42+
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/pluginsGLPI/empty
43+
```
44+
45+
2. Resolve conflicts, if any
46+
3. Run `git cherry-pick --continue`
47+
48+
For more advanced options, refer to [the documentation of _template sync_](https://github.com/coopTilleuls/template-sync#template-sync).

0 commit comments

Comments
 (0)