From c81ba69237b7314704a69ac58c4f96e7a1a8ba00 Mon Sep 17 00:00:00 2001 From: Hyeseong Kim <cometkim.kr@gmail.com> Date: Thu, 5 Sep 2019 03:04:36 +0900 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f9a4a5..00b36a2 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,35 @@ Watch changes, Automatically generates TypeScript definitions. - [x] Schema extraction - [x] Generates code using graphql-codegen -- [ ] Auto-fixing codes using `<StaticQuery>` and `useStaticQuery()` with generated type parameter. +- [ ] Options to customize inputs/outputs (More plugins, Schema-JSON/SDL output option, Type definitions, etc) +- [ ] Auto-fixing codes using `<StaticQuery>` and `useStaticQuery()` with generated type parameters. ## Requirements - Node v10.0.0 + - GatsbyJS v2 + +## Install + +```bash +yarn add gatsby-plugin-typegen + +# or +# npm install --save gatsby-plugin-typegen +``` + +## How to use + +```js +// In your gatsby-config.js +plugins: [`gatsby-plugin-typegen`] +``` + +## Available options + +TODO + ## Acknowledgements -- [graphql-plugin-extract-code](https://github.com/NickyMeuleman/gatsby-plugin-extract-schema) +- [gatsby-plugin-extract-code](https://github.com/NickyMeuleman/gatsby-plugin-extract-schema) - [graphql-code-generator](https://graphql-code-generator.com/) -- GitLab