Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
d-strobel committed Dec 27, 2023
1 parent 311e86b commit fd67e2b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br>
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
Expand Down
3 changes: 1 addition & 2 deletions client.go
Original file line number Diff line number Diff line change
@@ -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 (
Expand Down

0 comments on commit fd67e2b

Please sign in to comment.