diff --git a/README.md b/README.md index 2f9a4a5d79a1badd835c7833632c4d791bfca915..00b36a2e42b6a7203e56852782cd687c77155e08 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/)