github-schema 1.0.0 → 1.1.1

package/README.md

@@ -2,9 +2,6 @@
 
 > GitHub's GraphQL Schema
 
-<br/>
-<br/>
-
 ## 📦 Installation
 
 ```sh
@@ -12,8 +9,9 @@ npm install github-schema
 ```
 
 ## 📚 Usage
+
 ```ts
-import { gql } from "github-schema";
+import { gql, gqlTyped } from "github-schema";
 
 // we are also exporting a ton of types from the graphql schema.
 
@@ -38,9 +36,24 @@ const REPOSITORY_QUERY = gql`
 `;
 ```
 
+> [!NOTE]
+> If you want to use `gql` with return type of `DocumentNode` you can do something like this:
+
+```ts
+import { gqlTyped } from "github-schema";
+```
+
+## Editor Autocompletion
+
+> [!NOTE]
+> You will need to have [GraphQL LSP](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql) installed, and have a `.graphqlrc.yaml` file in your project root.  
+> If you also want nice colors, i would recommend [GraphQL Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql-syntax) installed.
+
 ```yaml
 # .graphqlrc.yaml
 schema: node_modules/github-schema/schema.graphql
 ```
 
-Published under [MIT License](./LICENCE).
+## 📄 License
+
+Published under [MIT License](./LICENSE).

package/dist/chunk-GEXVORGP.mjs

@@ -0,0 +1,6 @@
+// src/raw.ts
+function gql(raw, ...keys) {
+  return keys.length === 0 ? raw[0] : String.raw({ raw }, ...keys);
+}
+
+export { gql };

package/dist/github-schema.cjs

@@ -0,0 +1,2 @@
+'use strict';
+