Skip to content

Commit 0ae6682

Browse files
alexherrerocopybara-github
authored andcommitted
Add a README for the Winlog package.
PiperOrigin-RevId: 326350685
1 parent 4828de6 commit 0ae6682

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

winlog/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Overview
2+
3+
The Winlog package is a native Go Windows Event Log API. Supported features
4+
include full reading, filtering and rendering of event logs on Windows from a go
5+
binary.
6+
7+
## Features
8+
9+
* **Reading Event Logs** - Event logs are read using native Microsoft syscalls
10+
for log reading that is quick and requires minimal resources.
11+
12+
* **Filtering Event Logs** - Event logs that are read can be tailored using
13+
standard XML filtering strings.
14+
15+
* **Rendering Event Logs** - If the full text of an event log is desired, it can
16+
be rendered in its entirety for use elsewhere.
17+
18+
## Requirements
19+
20+
Any recent version of Windows 10 or Windows Server 2012 R2 and up is
21+
compatible with this library.
22+
23+
## How to use this library
24+
25+
See the examples folder for additional help and examples demonstrating the use
26+
of this library.
27+
28+
## Contact
29+
30+
We have a public discussion list at
31+
[google-winops@googlegroups.com](https://groups.google.com/forum/#!forum/google-winops)
32+
33+
## Disclaimer
34+
35+
This is not an official Google product.
36+
37+

0 commit comments

Comments
 (0)