doc: add readme

This commit is contained in:
fukusuket
2025-05-12 10:49:15 +09:00
parent fca5a519ed
commit 9f511dfcc7

View File

@@ -64,6 +64,9 @@ WELA helps identify these issues and provides actionable recommendations to impr
![WELA FileSize](screenshots/filesize.png) ![WELA FileSize](screenshots/filesize.png)
# Features # Features
- **Audit Windows Event Log settings**: Check the current settings of Windows Event Logs and compare them with recommended settings.
- Checking Windows Event Log audit settings based on **real-world Sigma rule detectability**.
- **Audit Windows Event Log file sizes**: Check the current file sizes of Windows Event Logs and compare them with recommended settings.
# Prerequisites # Prerequisites
* PowerShell 5.1+ * PowerShell 5.1+
@@ -78,11 +81,6 @@ Please download the latest stable version of WELA from the [Releases](https://gi
2. Open PowerShell with **Administrator privileges**. 2. Open PowerShell with **Administrator privileges**.
3. `./WELA.ps1 help` to run WELA. 3. `./WELA.ps1 help` to run WELA.
# Command List
* `audit-settings`: Audit Windows Event Log settings
* `audit-filesize`: Audit Windows Event Log file sizes
* `update-rules` : Update Sigma contents in config directory
# Command Usage # Command Usage
## audit-settings ## audit-settings
## audit-filesize ## audit-filesize