8000 update README for when the refactor branch is merged to main · HarshvMahawar/tools-python@563196d · GitHub
[go: up one dir, main page]

Skip to content

Commit 563196d

Browse files
update README for when the refactor branch is merged to main
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
1 parent 69e938a commit 563196d

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,22 @@ CI status (Linux, macOS and Windows): [![Install and Test][1]][2]
77
[2]: https://github.com/spdx/tools-python/actions/workflows/install_and_test.yml
88

99

10-
# Current state
10+
# Current state, please read!
1111

1212
This repository was subject to a major refactoring recently to get ready for the upcoming SPDX v3.0 release.
1313
Therefore, we'd like to encourage you to post any and all issues you find at https://github.com/spdx/tools-python/issues.
14-
If you prefer a version that has been longer in use, please check out
15-
the [latest release](https://github.com/spdx/tools-python/releases/tag/v0.7.0).
14+
If you are looking for the source code of the [current PyPI release](https://pypi.python.org/pypi/spdx-tools), check out
15+
the [v0.7.1 branch](https://github.com/spdx/tools-python/tree/release/v0.7.1).
1616
Note, though, that this will only receive bug fixes but no new features.
1717

18+
We encourage you to use the new, refactored version (on the main branch) if you
19+
- want to use the soon-to-be released SPDX v3.0 in the future
20+
- want to perform full validation of your SPDX documents against the v2.2 and v2.3 specification
21+
- want to use the RDF format of SPDX with all v2.3 features.
22+
23+
If you are planning to migrate from v0.7.x of these tools,
24+
please have a look at the [migration guide](https://github.com/spdx/tools-python/wiki/How-to-migrate-from-0.7-to-1.0).
25+
1826
# Information
1927

2028
This library implements SPDX parsers, convertors, validators and handlers in Python.

0 commit comments

Comments
 (0)
0