Skip to content

Commit

Permalink
fix: wrong repository link in docs (#16)
Browse files Browse the repository at this point in the history
* fix: wrong repository link in docs

* Update README.md

---------

Co-authored-by: Emmanuel Barat <[email protected]>
  • Loading branch information
laryjulien and mano-lis authored Jan 12, 2024
1 parent 7612a16 commit 825c71d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Template Sync will import the changes made to the template to your project in a
## Getting Started

```console
curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- <url-of-the-template>
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- <url-of-the-template>
```
If you have some conflicts, resolve them and run `git cherry-pick --continue`.

Expand All @@ -26,13 +26,13 @@ Therefore you just have to resolve conflicts and work is done!

### Monorepo containing multiple templates

Using this kind of templates, you have to specify the subdirectory where your template is with
Using this kind of templates, you have to specify the subdirectory where your template is with
the `--directory` flag.

For example, assume you work on a project base on the template "api-routes" from next starters.
The main monorepo is vercel/next.js and the template is located in examples/api-routes :
```console
curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- https://github.com/vercel/next.js --directory=examples/api-routes
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/vercel/next.js --directory=examples/api-routes
```

### Advanced
Expand All @@ -43,15 +43,15 @@ Copy template-sync.sh at the root of your project
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
curl -sSL https://raw.githubusercontent.com/coopTilleuls/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%).
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
curl -sSL https://raw.githubusercontent.com/coopTilleuls/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 825c71d

Please sign in to comment.