JetBrains / js-graphql-intellij-plugin

GraphQL language support for WebStorm, IntelliJ IDEA and other IDEs based on the IntelliJ Platform.
https://jimkyndemeyer.github.io/js-graphql-intellij-plugin/
MIT License
879 stars 97 forks source link

Add documentation to the README.md #500

Closed vepanimas closed 1 year ago

vepanimas commented 2 years ago

We need to describe in the README the most important aspects of configuring and using the plugin. Providing documentation on a separate website or in the other repo is not very discoverable.

Sections to add:

  1. Configuration files, their syntax, possible project layouts for different scenarios.
  2. Environment variables.
  3. Schema introspection.
  4. Writing and executing queries.
  5. Using Scratch files for writing queries (especially comment-based schema configuration in them).
  6. Frameworks support.
  7. FAQ