Skip to content

Commit bc6851f

Browse files
committed
Added README file
1 parent e7f793d commit bc6851f

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.MD

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Posh-SYSLOG
2+
3+
## Description
4+
5+
A module for sending SYSLOG messages from PowerShell.
6+
7+
The module supports RFC5424 and RFC3164, and can send messages via TCP and UDP.
8+
9+
Authored by Kieran Jacobsen
10+
11+
## Installing
12+
13+
The easiest way to get Posh-SYSLOG is using the [PowerShell Gallery](https://powershellgallery.com/packages/Posh-SYSLOG/)!
14+
15+
### Inspecting the module
16+
17+
Best practice is that you inspect modules prior to installing them. You can do this by saving the module to a local path:
18+
19+
``` PowerShell
20+
PS> Save-Module -Name Posh-SYSLOG -Path <path>
21+
```
22+
23+
### Installing the module
24+
25+
Once you trust a module, you can install it using:
26+
27+
``` PowerShell
28+
PS> Install-Module -Name Posh-SYSLOG
29+
```
30+
31+
### Updating Posh-SYSLOG
32+
33+
Once installed from the PowerShell Gallery, you can update it using:
34+
35+
``` PowerShell
36+
PS> Update-Module -Name Posh-SYSLOG
37+
```
38+
39+
### Removing Posh-SYSLOG
40+
41+
To remove Posh-SYSLOG:
42+
43+
``` PowerShell
44+
PS> Uninstall-Module -Name Posh-SYSLOG
45+
```
46+
47+
## License
48+
49+
Posh-SYSLOG is provided under the [MIT license](LICENSE.md).

0 commit comments

Comments
 (0)