From f2e869460eeffa491675c9cd4b8aa581b0789849 Mon Sep 17 00:00:00 2001 From: Daniel Harvey Date: Sun, 5 Apr 2020 14:39:12 +0100 Subject: [PATCH] Readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f7f343b..92c7d9e 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,29 @@ This library is a plugin for `GraphQL Code Generator` that creates `fast-check` ## How to use -_ahem_ +Add the library to your project (and GraphQL Codegen if you need it): + +```bash +yarn add graphql-codegen-fast-check @graphql-codegen/cli +``` + +Create a `codegen.yml` file. + +```yaml +schema: path-to-my-graphql-schema.graphql +generates: + output.ts: + - graphql-codegen-fast-check +``` + +Then run the generator in the same folder as your `codegen.yml` file: + +```bash +yarn graphql-codegen +``` + +(hopefully) Success! You should have an `output.ts` folder full of `arbitrary`s +you can use in your project. ## What's working?