Skip to content

Commit

Permalink
Merge pull request #532 from creative-commoners/pulls/5.0/cms5-readme
Browse files Browse the repository at this point in the history
PHPUnit tests failed are unrelated to this PR
  • Loading branch information
sabina-talipova authored Apr 21, 2023
2 parents 5af4fea + e4a2cc0 commit dbe5fab
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,12 @@ introspection. It layers a pluggable schema registration system on top of the
[graphql-php](https://github.com/webonyx/graphql-php) library. The APIs are
very similar.

## This is the 4.x release branch

If you are looking for version 3 [check the `3` branch](https://github.com/silverstripe/silverstripe-graphql/tree/3), which contains documentation inlined into the README.

## Installing on silverstripe/recipe-cms < 4.11

If your project uses `silverstripe/recipe-cms`, you cannot install the stable version 4 release. You can use version 3 (which will be installed by default), or you can swap to the alpha of version 4 by running this command:
## Installation

```sh
composer require silverstripe/graphql
```
composer require silverstripe/graphql:^4.0.0-alpha --with-all-dependencies
```

Alternatively, you can remove `silverstripe/recipe-cms` from your root `composer.json` and replace it with the contents of the `composer.json` in `silverstripe/recipe-cms`.

## Documentation

See [doc.silverstripe.org](https://doc.silverstripe.org/en/4/developer_guides/graphql/).
See [docs.silverstripe.org](https://docs.silverstripe.org/en/developer_guides/graphql/).

0 comments on commit dbe5fab

Please sign in to comment.