Skip to content

Commit

Permalink
Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Cito committed Jan 26, 2025
1 parent 0270754 commit b7935f7
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit b7935f7

Please sign in to comment.