Skip to content

Commit 6b3986d

Browse files
Added getting started docs (#32)
1 parent 7ec1738 commit 6b3986d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ To install it, open "Settings", "Plugins", "Browse repositories..." and search f
4242

4343
**Note**: The experimental version in the `android-studio` branch is not available from the JetBrains Plugin Repository.
4444

45+
**How do I configure the plugin in a project**
46+
47+
The plugin is activated as soon as you view or edit GraphQL in the editor. This includes GraphQL inside `Relay.QL` and `gql` templates in JavaScript and TypeScript. You can also use `.graphql` physical files and scratch files. These files allow you to query your endpoint directly from your IDE.
48+
49+
An editor notification bar should prompt you to "Create a graphql.config.json". Accept and edit this config file to point the plugin at your local `schema.json` or your endpoint for introspection. The plugin uses the schema to provide completion and error highlighting.
50+
4551
**How do I reload a GraphQL Schema that was loaded from a URL?**
4652

4753
In the the GraphQL tool window, select the "Current Errors" tab and click the "Restart JS GraphQL Language Service" button.

0 commit comments

Comments
 (0)