Skip to content

Commit 134f5d8

Browse files
StartAutomatingStartAutomating
StartAutomating
authored and
StartAutomating
committed
docs: Adding README.ps.md ( Fixes #1 )
1 parent 4bb963d commit 134f5d8

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

+51-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
1+
<div align='center'>
2+
<img alt='GQL Logo (Animated)' style='width:33%' src='Assets/GQL-Animated.svg' />
3+
</div>
4+
15
# GQL
2-
Get GraphQL in PowerShell
6+
7+
Get Graph Query Language with PowerShell.
8+
9+
GQL is a small PowerShell module for GraphQL.
10+
11+
It is designed to provide a simple GraphQL client in PowerShell.
12+
13+
We can use this as a direct client to GraphQL, without having to involve any other layer.
14+
15+
16+
## GQL Container
17+
18+
You can use the GQL module within a container:
19+
20+
~~~powershell
21+
docker pull ghcr.io/powershellweb/gql
22+
docker run -it ghcr.io/powershellweb/gql
23+
~~~
24+
25+
### Installing and Importing
26+
27+
~~~PowerShell
28+
Install-Module GQL -Scope CurrentUser -Force
29+
Import-Module GQL -Force -PassThru
30+
~~~
31+
32+
### Get-GQL
33+
34+
To connect to a GQL and get results, use [Get-GQL](Get-GQL.md), or, simply `GQL`.
35+
36+
(like all functions in PowerShell, it is case-insensitive)
37+
38+
### More Examples
39+
40+
#### Get-GQL Example 1
41+
42+
~~~powershell
43+
# Getting git sponsorship information from GitHub GraphQL.
44+
# **To use this example, we'll need to provide `$MyPat` with a Personal Access Token.**
45+
Get-GQL -Query ./Examples/GitSponsors.gql -PersonalAccessToken $myPat
46+
~~~
47+
#### Get-GQL Example 2
48+
49+
~~~powershell
50+
# We can decorate graph object results to customize them.
51+
~~~
52+

0 commit comments

Comments
 (0)