diff --git a/README.md b/README.md index 9b777e1f..84c5f7f4 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,16 @@ a query language for APIs created by Facebook. The current version 3.2.6 of GraphQL-core is up-to-date with GraphQL.js version 16.8.2. -An extensive test suite with over 2300 unit tests and 100% coverage comprises a +An extensive test suite with over 2500 unit tests and 100% coverage comprises a replication of the complete test suite of GraphQL.js, making sure this port is reliable and compatible with GraphQL.js. -Note that for various reasons, GraphQL-core does not use SemVer like GraphQL.js. Increases in the major version of GraphQL.js are reflected in the minor version of GraphQL-core instead. This means there can be breaking changes in the API when the minor version changes, and only patch releases are fully backward compatible. Therefore, we recommend something like `=~ 3.2.0` as version specifier when including GraphQL-core as a dependency. +Note that for various reasons, GraphQL-core does not use SemVer like GraphQL.js. +Changes in the major version of GraphQL.js are reflected in the minor version of +GraphQL-core instead. This means there can be breaking changes in the API +when the minor version changes, and only patch releases are fully backward compatible. +Therefore, we recommend using something like `~= 3.2.0` as the version specifier +when including GraphQL-core as a dependency. ## Documentation @@ -48,8 +53,8 @@ GraphQL-core 3 can be installed from PyPI using the built-in pip command: python -m pip install graphql-core -You can also use [poetry](https://github.com/python-poetry/poetry) for installation in a -virtual environment: +You can also use [poetry](https://github.com/python-poetry/poetry) for installation +in a virtual environment: poetry install