Skip to content

Commit

Permalink
docs: Adding README.ps.md ( Fixes #1 )
Browse files Browse the repository at this point in the history
  • Loading branch information
StartAutomating authored and StartAutomating committed Dec 19, 2024
1 parent 134f5d8 commit 6129630
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,51 @@
<div align='center'>
<img alt='GQL Logo (Animated)' style='width:33%' src='Assets/GQL-Animated.svg' />
</div>

# GQL
Get GraphQL in PowerShell

Get Graph Query Language with PowerShell.

GQL is a small PowerShell module for GraphQL.

It is designed to provide a simple GraphQL client in PowerShell.

We can use this as a direct client to GraphQL, without having to involve any other layer.


## GQL Container

You can use the GQL module within a container:

~~~powershell
docker pull ghcr.io/powershellweb/gql
docker run -it ghcr.io/powershellweb/gql
~~~

### Installing and Importing

~~~PowerShell
Install-Module GQL -Scope CurrentUser -Force
Import-Module GQL -Force -PassThru
~~~

### Get-GQL

To connect to a GQL and get results, use [Get-GQL](Get-GQL.md), or, simply `GQL`.

(like all functions in PowerShell, it is case-insensitive)

### More Examples

#### Get-GQL Example 1

~~~powershell
# Getting git sponsorship information from GitHub GraphQL.
# **To use this example, we'll need to provide `$MyPat` with a Personal Access Token.**
Get-GQL -Query ./Examples/GitSponsors.gql -PersonalAccessToken $myPat
~~~
#### Get-GQL Example 2

~~~powershell
# We can decorate graph object results to customize them.
~~~

0 comments on commit 6129630

Please sign in to comment.