diff --git a/Documentation~/installation.md b/Documentation~/installation.md index 1208a9c..27c49c3 100644 --- a/Documentation~/installation.md +++ b/Documentation~/installation.md @@ -83,20 +83,15 @@ unverified work always appear. ## Add the Package with UPM Open **Window > Package Management > Package Manager**, choose **+ > Install -package from git URL...**, and enter the tagged `v2.0.0` release: - -```text -https://github.com/martincalander/GitSubmoduleManager.git#v2.0.0 -``` - -Replace `v2.0.0` with another published release tag when upgrading. An -unqualified repository URL follows the mutable `main` branch and should be used -only for development or pre-release testing: +package from git URL...**, and enter: ```text https://github.com/martincalander/GitSubmoduleManager.git ``` +The unqualified URL follows `main`. To pin a published release instead, append +its tag to the URL. + ## Team Clone Setup Clone a project and initialize all registered submodules with: @@ -155,16 +150,15 @@ changing only the revision is not sufficient: ```json { "dependencies": { - "com.martincalander.gitsubmodulemanager": "https://github.com/martincalander/GitSubmoduleManager.git#" + "com.martincalander.gitsubmodulemanager": "https://github.com/martincalander/GitSubmoduleManager.git" } } ``` Remove the old `com.essentials.gitpackagemanager` or `com.martincalander.gitpackagemanager` key and let Unity regenerate -`Packages/packages-lock.json`. Replace `` with a published -tag that includes the Git Submodule Manager identity. No 1.x tag was published -from this repository; `v2.0.0` is the first tag under the current identity. +`Packages/packages-lock.json`. No 1.x tag was published from this repository. +Append a published tag only when the project needs a pinned package revision. For a submodule installation, also coordinate the parent repository's gitlink and `.gitmodules` path from either diff --git a/README.md b/README.md index cc2ba98..1d3eb58 100644 --- a/README.md +++ b/README.md @@ -53,15 +53,15 @@ Windows, macOS, and Linux. ## Installation -Install the tagged `v2.0.0` release from **Window > Package Management > Package -Manager > + > Install package from git URL...**: +In **Window > Package Management > Package Manager**, choose **+ > Install +package from git URL...** and enter: ```text -https://github.com/martincalander/GitSubmoduleManager.git#v2.0.0 +https://github.com/martincalander/GitSubmoduleManager.git ``` -An unqualified repository URL follows the mutable `main` branch and is intended -only for development or pre-release testing. +This URL follows `main`. To pin a published release instead, append its tag to +the URL. ## Quick Start