From e4a2cc083ed84f593b608614ac58cb426c1f9f05 Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Wed, 19 Apr 2023 16:18:30 +1200 Subject: [PATCH] DOC Update README.md for CMS 5 --- README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fdac1d8d..4aa25d28 100644 --- a/README.md +++ b/README.md @@ -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/).