Skip to content

Commit 7e9c521

Browse files
authored
Document the 1.x / 2.x split and alias dev-main to 2.0.x-dev (#10)
Branch `1` now holds the CMS 5 line and `main` carries CMS 6 / Forager 2 support, tagged 2.0.0-alpha1. Add a branch-alias so existing dev-main consumers are not silently moved onto the 2.x code, and a README table explaining which line to install.
1 parent b276953 commit 7e9c521

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,22 @@ interchangably in this module. This module does not currently provide support fo
2525

2626
## Installation
2727

28+
### Which version?
29+
30+
| Line | Branch and tags | Requires | Status |
31+
| --- | --- | --- | --- |
32+
| 1.x | branch `1`, tags `1.0.0``1.1.0` | Silverstripe CMS 5, Forager `^1.3`, PHP `^8.1` | Supported stable line |
33+
| 2.x | branch `main`, tag `2.0.0-alpha1` | Silverstripe CMS 6, Forager `^2.0`, PHP `^8.3` | Alpha release |
34+
35+
Install the latest 1.x release for CMS5 with:
36+
2837
`composer require silverstripe/silverstripe-forager-elastic-enterprise`
2938

39+
The 2.x line adds CMS 6 and Forager 2 support. It is tagged as an alpha because the API may change with future updates.
40+
Composer will not resolve it unless you opt in explicitly:
41+
42+
`composer require silverstripe/silverstripe-forager-elastic-enterprise:^2.0@alpha`
43+
3044
## Activating EnterpriseSearch
3145

3246
To start using Elastic Enterprise Search, define environment variables containing your private API key, endpoint, and

composer.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@
4444
"SilverStripe\\ForagerElasticEnterprise\\Tests\\": "tests/"
4545
}
4646
},
47+
"extra": {
48+
"branch-alias": {
49+
"dev-main": "2.0.x-dev"
50+
}
51+
},
4752
"minimum-stability": "dev",
4853
"prefer-stable": true,
4954
"config": {

0 commit comments

Comments
 (0)