From 3494f01e033774365f2c797a80a3bc907ef43f75 Mon Sep 17 00:00:00 2001
From: Marc Collins <mmarccollins@gmail.com>
Date: Fri, 9 Sep 2022 14:02:52 +1000
Subject: [PATCH] Updated with Connection Examples

---
 ReadMe.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/ReadMe.md b/ReadMe.md
index 769aa64..3e7e69b 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -22,5 +22,66 @@ Issues can be reported via the GitHub Repository [Issues](https://github.com/Qli
 
 Further information around the QRS API's can be found in the [OpenAPI](https://help.qlik.com/en-US/sense-developer/APIs/RepositoryServiceAPI/index.html) specification
 
+## Installation
+```PowerShell
+Get-PackageProvider -Name NuGet -ForceBootstrap
+
+# Install for all users, requires admin rights
+Install-Module QlikSenseCLI
+
+# Install for current user
+Install-Module QlikSenseCLI -Scope CurrentUser
+```
+
+```PowerShell
+# Once Installed you can import the Module
+Import-Module QlikSenseCLI
+
+# Then to Connect to Qlik Sense you can use one of the following with the Optional Parameters
+
+# Current User
+Connect-QlikSense [[-Hostname] <string>] [[-VirtualProxy] <string>] [[-TrustAllCertificates]]
+    
+# Specified Credentials
+Connect-QlikSense [[-Hostname] <string>] [[-VirtualProxy] <string>] [[-Credential] <NetworkCredential>] [[-TrustAllCertificates]]  
+    
+# Qlik Client Certificate
+Connect-QlikSense [[-Hostname] <string>] [[-Username] <string>] [[-Certificate] <X509Certificate2>][[-TrustAllCertificates]]  
+```
+
+### Connection Examples
+```PowerShell
+# Connect to local host as current user
+Connect-QlikSense
+
+# Connect to local host as current user on specific virtual proxy
+Connect-QlikSense -VirtualProxy "MyVP" -TrustAllCertificates
+
+# Connect to Remote host on specific Virtual proxy as the current user
+Connect-QlikSense -Hostname "MySenseServer" -VirtualProxy "MyVP" -TrustAllCertificates
+```
+
+```PowerShell
+# Connect to Local host with Specified Credentials
+$Credentials = Get-Credential
+Connect-QlikSense -Credential $Credentials -TrustAllCertificates
+
+# Connect to Remote host on with Specified Credentials on specific Virtual proxy 
+$Credentials = Get-Credential
+Connect-QlikSense -Hostname "MySenseServer" -VirtualProxy "MyVP" -Credential $Credentials  -TrustAllCertificates
+```
+
+```PowerShell
+# Connect to Local host on with QlikClient Certificate as Specified User
+$QlikClientCertificate = Get-ChildItem Cert:\CurrentUser\My\ | ? { $_.Subject -eq "CN=QlikClient" }
+Connect-QlikSense -Certificate $QlikClientCertificate -Username "Domain\User" -TrustAllCertificates
+
+# Connect to Remote host on with QlikClient Certificate as Specified User
+$QlikClientCertificate = Get-ChildItem Cert:\CurrentUser\My\ | ? { $_.Subject -eq "CN=QlikClient" }
+Connect-QlikSense -Hostname "MySenseServer" -Certificate $QlikClientCertificate -Username "Domain\User" -TrustAllCertificates
+```
+
+
+
 ### TO DO
 Usage examples Coming soon!
\ No newline at end of file