Skip to content

Commit 4b895c0

Browse files
author
James Brundage
committed
docs: Adding README.ps.md ( Fixes #1 )
1 parent 820ed65 commit 4b895c0

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

Diff for: README.ps.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<div align='center'>
2+
<img alt='GQL Logo (Animated)' style='width:33%' src='Assets/GQL-Animated.svg' />
3+
</div>
4+
5+
# GQL
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+
~~~PipeScript{
41+
Import-Module .\
42+
Get-Help Get-GQL |
43+
%{ $_.Examples.Example.code} |
44+
% -Begin { $exampleCount = 0 } -Process {
45+
$exampleCount++
46+
@(
47+
"#### Get-GQL Example $exampleCount"
48+
''
49+
"~~~powershell"
50+
$_
51+
"~~~"
52+
''
53+
) -join [Environment]::Newline
54+
}
55+
}
56+
~~~

0 commit comments

Comments
 (0)