Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
Update the compatibility matrix with correct plugin versions and
branches.
  • Loading branch information
Maari Tamm committed Oct 2, 2024
1 parent 70c2b8b commit 47cff00
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ edX and Tutor version you are deploying. If you are installing this
plugin from a branch in this Git repository, you must select the
appropriate one:

| Open edX release | Tutor version | Plugin branch | Plugin release |
|-------------------|--------------------|---------------|----------------|
| Lilac | `>=12.0, <13` | Not supported | Not supported |
| Maple | `>=13.2, <14`[^v1] | `maple` | 0.3.x |
| Nutmeg | `>=14.0, <15` | `nutmeg` | 1.x.x |
| Olive | `>=15.0, <16` | `main` | 2.x.x |
| Palm | `>=16.0, <17` | `main` | 3.x.x |
| Quince | `>=17.0, <18` | `main` | 3.x.x |
| Redwood[^journal] | `>=18.0, <19` | `main` | 3.x.x |
| Open edX release | Tutor version | Plugin branch | Plugin release |
|-------------------|--------------------|---------------|-------------------|
| Lilac | `>=12.0, <13` | Not supported | Not supported |
| Maple | `>=13.2, <14`[^v1] | `maple` | 0.3.x |
| Nutmeg | `>=14.0, <15` | `nutmeg` | 1.x.x |
| Olive | `>=15.0, <16` | `olive` | 2.x.x |
| Palm | `>=16.0, <17` | `quince` | `>=2.1.0, <3.4.0` |
| Quince | `>=17.0, <18` | `quince` | `>=3.1.0, <3.4.0` |
| Redwood[^journal] | `>=18.0, <19` | `main` | `>=3.3.0` |

[^v1]: For Open edX Maple and Tutor 13, you must run version 13.3.0 or later.
That is because this plugin uses the Tutor v1 plugin API, [which was introduced with that release](https://github.com/overhangio/tutor/blob/master/CHANGELOG.md#v1320-2022-04-24).
Expand Down

0 comments on commit 47cff00

Please sign in to comment.