From fd67e2b6587ef3e3a132624c5ded6a0a7085b78d Mon Sep 17 00:00:00 2001 From: Dustin Strobel Date: Wed, 27 Dec 2023 20:12:59 +0100 Subject: [PATCH] docs: update documentation --- README.md | 7 ++++--- client.go | 3 +-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c3dc728..a42fdc4 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,12 @@ [![Conventional Commits][convention badge]][convention page] # gowindows -Go library for configuring Windows-based systems. +**gowindows** is a Go library designed for remotely configuring and managing Windows-based systems. ## Overview -**gowindows** is designed to simplify the configuration of Windows-based systems by providing a set of functions that interact with Windows.
-It is particularly useful when used in conjunction with the [terraform-provider-windows](https://github.com/d-strobel/terraform-provider-windows) for managing Windows resources. +Leveraging WinRM and SSH connections, gowindows provides a comprehensive set of functions to execute PowerShell commands, making it easy to automate tasks, manage users, groups, and more on remote Windows servers. + +This library is especially useful when combined with tools like Terraform, enabling seamless integration into infrastructure as code workflows for Windows environments. ## Usage ### Single Client with a WinRM Connection diff --git a/client.go b/client.go index fd571f2..6d2d738 100644 --- a/client.go +++ b/client.go @@ -1,5 +1,4 @@ -// Package gowindows provides a Go library for interacting with Windows-based systems. -// It is designed to be used in conjunction with a Terraform provider but it's usage can be extended. +// Package gowindows provides a Go library for interacting remotely with Windows-based systems. package gowindows import (