Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mano-lis authored Nov 9, 2023
1 parent 5af96d8 commit 06f7baa
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,19 @@ curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template
1. Go to your project repository (we recommend to create a new branch)
Copy template-sync.sh at the root of your project

2. The only mandatory argument is the GitHub or GitLab URL of your template.
E.g. `./template-sync.sh https://github.com/dunglas/symfony-docker`. If you want to synchronize your project with a specific version of the template, you can specify the commit you are targeting by adding `--commit=<commit SHA>`.
2. The only mandatory argument is the GitHub or GitLab URL of your template but if you want to synchronize your project with a specific version of the template, you can specify the commit you are targeting by adding `--commit=<commit SHA>`.
E.g. Assume your project is based on dunglas/symfony-docker and you just want to get the improvements of the new php app server [FrankenPHP](https://frankenphp.dev/). Run this command :
```console
curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- https://github.com/dunglas/symfony-docker --commit=88f5c19
```

3. In case some files are renamed or moved in the template history, you can modify the threshold where
git considers two files as identical. Default value for this script is 20% (git's default value is 50%).
E.g. `./template-sync.sh https://github.com/dunglas/symfony-docker --threshold=30`
If git is confused and considers files that are not identical to be identical, you can raise this threshold.
E.g;
```console
curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- <url-of-the-template> --threshold=30
```

4. You can run the script in debug mode by adding the `--debug` flag.

Expand Down

0 comments on commit 06f7baa

Please sign in to comment.