diff --git a/README.md b/README.md index 8b638539..6afb9e7b 100644 --- a/README.md +++ b/README.md @@ -25,20 +25,29 @@ This repository contains several related components: # VRS-Python and VRS Version Correspondence The ga4gh/vrs-python repo embeds the ga4gh/vrs repo as a git submodule, and -therefore each ga4gh.vrs package on PyPi embeds a particular version of VRS. The -correspondences between the packages may be summarized as: +therefore each ga4gh.vrs package on PyPI embeds a particular version of VRS. The +correspondences between the packages that are **currently maintained** may be summarized as: -| vrs-python branch | vrs branch | -| ----------------------------------------------------- | ------------------------------------------------------------------------ | -| [main](https://github.com/ga4gh/vrs-python/tree/main) | [main](https://github.com/ga4gh/vrs/tree/main) | -| [0.6](https://github.com/ga4gh/vrs-python/tree/0.6) | [1.1](https://github.com/ga4gh/vrs/tree/1.1) | -| [0.7](https://github.com/ga4gh/vrs-python/tree/0.7) | [1.2](https://github.com/ga4gh/vrs/tree/1.2) | -| [0.8](https://github.com/ga4gh/vrs-python/tree/0.8) | [1.3](https://github.com/ga4gh/vrs/tree/1.3) | -| [0.9](https://github.com/ga4gh/vrs-python/tree/0.9) | [metaschema-update](https://github.com/ga4gh/vrs/tree/metaschema-update) | +| vrs-python branch | vrs-python tag/version | vrs branch | vrs version | +| --- | --- | --- | --- | +| [2.x](https://github.com/ga4gh/vrs-python/tree/2.x) _(default branch)_ | 2.x | [2.x](https://github.com/ga4gh/vrs/tree/2.x) | 2.x +| [1.x](https://github.com/ga4gh/vrs-python/tree/1.x) | 0.8.x | [1.x](https://github.com/ga4gh/vrs/tree/1.x) | 1.x | + +⚠ **Note: Only 2.x branch is being actively maintained. The 1.x branch will only be maintained for bug fixes.** ⚠ **Developers: See the development section below for recommendations for using submodules gracefully (and without causing problems for others!).** +## Previous VRS-Python and VRS Version Correspondence + +The correspondences between the packages that are **no longer maintained** may be summarized as: + +| vrs-python branch | vrs-python tag/version | vrs branch | vrs version | +| --- | --- | --- | --- | +| [0.6](https://github.com/ga4gh/vrs-python/tree/0.6) | 0.6.x | [1.1](https://github.com/ga4gh/vrs/tree/1.1) | 1.1.x | +| [0.7](https://github.com/ga4gh/vrs-python/tree/0.7) | 0.7.x | [1.2](https://github.com/ga4gh/vrs/tree/1.2) | 1.2.x | +| [0.9](https://github.com/ga4gh/vrs-python/tree/0.9) | 0.9.x | [metaschema-update](https://github.com/ga4gh/vrs/tree/metaschema-update) | N/A | + # Pre-requisite [Python 3.10](https://www.python.org/downloads/release/python-3100/)