From d6ab262ed87112dbed89c404fab4fd32281b1d27 Mon Sep 17 00:00:00 2001 From: Rob Richard Date: Mon, 16 Nov 2020 18:21:02 -0500 Subject: [PATCH] README: add instructions on using experimental features (#2849) Co-authored-by: Ivan Goncharov --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 47cce6ad6a..733e424d32 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,16 @@ directly on this branch: npm install graphql@git://github.com/graphql/graphql-js.git#npm ``` +### Experimental features + +Each release of GraphQL.js will be accompanied by an experimental release containing support for the `@defer` and `@stream` directive proposal. We are hoping to get community feedback on these releases before the proposal is accepted into the GraphQL specification. You can use this experimental release of GraphQL.js by adding the following to your project's `package.json` file. + +``` +"graphql": "experimental-stream-defer" +``` + +Community feedback on this experimental release is much appreciated and can be provided on the [issue created for this purpose](https://github.com/graphql/graphql-js/issues/2848). + ### Using in a Browser GraphQL.js is a general-purpose library and can be used both in a Node server