From 61296303526f466bda2ba09d24a08540e25068d1 Mon Sep 17 00:00:00 2001
From: StartAutomating <StartAutomating@github.com>
Date: Thu, 19 Dec 2024 07:18:30 +0000
Subject: [PATCH] docs: Adding README.ps.md ( Fixes #1 )

---
 docs/README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

diff --git a/docs/README.md b/docs/README.md
index f45ff11..5989d74 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -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.
+~~~