Files
WELA/README.md
T
Shirofune-Security ccf33bed31 docs: replace README with a landing page pointing to the documentation site
The WELA documentation now lives on a dedicated docs site
(https://yamato-security.github.io/WELA/). Replace the long single-page README
with a short landing page that points there, and preserve the originals.

- README.md / README-Japanese.md -> OLD-README.md / OLD-README-Japanese.md
  (their language-switcher cross-links updated to point at each other)
- New README.md: logo, badges, a prominent link to the docs site and its main
  sections, downloads, links to the archived READMEs, and the MIT license

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-29 10:15:41 +09:00

81 lines
3.9 KiB
Markdown

<div align="center">
<p>
<img alt="WELA Logo" src="screenshots/WELA-Logo.png" width="20%">
<h1>
WELA (Windows Event Log Analyzer) ゑ羅
</h1>
</p>
<p>
<b>A tool for auditing Windows event log settings.</b><br/>
Created by <a href="https://github.com/Yamato-Security">Yamato Security</a> — make sure you are
actually recording the events that matter for DFIR.
</p>
<p>
<a href="https://github.com/Yamato-Security/WELA/releases"><img src="https://img.shields.io/github/v/release/Yamato-Security/WELA?color=blue&label=Stable%20Version&style=flat"/></a>
<a href="https://github.com/Yamato-Security/WELA/releases"><img src="https://img.shields.io/github/downloads/Yamato-Security/WELA/total?style=flat&label=GitHub%F0%9F%A6%85Downloads&color=blue"/></a>
<a href="https://github.com/Yamato-Security/WELA/stargazers"><img src="https://img.shields.io/github/stars/Yamato-Security/WELA?style=flat&label=GitHub%F0%9F%A6%85Stars"/></a>
<a href="https://github.com/Yamato-Security/WELA/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat"/></a>
<a href="https://conference.auscert.org.au/speaker/fukusuke-takahashi/"><img src="https://img.shields.io/badge/AUSCERT-2025-blue"></a>
<a href="https://www.infosec-city.com/sin-25"><img src="https://img.shields.io/badge/SINCON-2025-blue"></a>
<a href="https://codeblue.jp/program/time-table/day2-t3-02/"><img src="https://img.shields.io/badge/CODE%20BLUE-2025-blue"></a>
<a href="https://twitter.com/SecurityYamato"><img src="https://img.shields.io/twitter/follow/SecurityYamato?style=social"/></a>
</p>
<h2>
📖 <a href="https://yamato-security.github.io/WELA/">Read the Documentation&nbsp;→</a>
</h2>
<sub>
Available in 15 languages — English · 日本語 · 繁體中文 · 한국어 · Deutsch · Türkçe · Français ·
Español · Português (Brasil) · Українська · हिन्दी · Bahasa Indonesia · မြန်မာဘာသာ · ไทย · العربية
</sub>
</div>
---
## 🦅 About
WELA (Windows Event Log Analyzer, ゑ羅) is a **tool for auditing Windows event log settings**.
Windows event logs are a vital source of information for Digital Forensics and Incident Response
(DFIR) — WELA checks your audit policy and log file sizes against best-practice guidelines and
real-world Sigma-rule detectability, and can apply the recommended settings for you.
## 📖 Documentation
All documentation now lives on a dedicated, searchable, multi-language site:
> ### 👉 **[yamato-security.github.io/WELA](https://yamato-security.github.io/WELA/)**
| Section | |
| --- | --- |
| 🚀 [Getting Started](https://yamato-security.github.io/WELA/getting-started/) | Prerequisites, downloads and running WELA |
| ⌨️ [Command Reference](https://yamato-security.github.io/WELA/commands/) | `audit-settings`, `audit-filesize`, `configure`, `update-rules` |
| ✨ [Features](https://yamato-security.github.io/WELA/overview/features/) | What WELA can do |
| 📦 [Resources](https://yamato-security.github.io/WELA/resources/companion-projects/) | Companion projects, changelog, contributing |
## ⬇️ Download
Grab the latest release from the [**Releases page**](https://github.com/Yamato-Security/WELA/releases).
## 🗂️ Looking for the old README?
The previous single-page README is preserved unchanged:
- 📄 [**OLD-README.md**](OLD-README.md) — English
- 📄 [**OLD-README-Japanese.md**](OLD-README-Japanese.md) — 日本語
## 🤝 Contributing & License
Contributions and bug reports are welcome — see
[Contributing & Support](https://yamato-security.github.io/WELA/resources/contributing/).
WELA is released under the [MIT license](LICENSE).
---
<div align="center">
Made by <a href="https://github.com/Yamato-Security">Yamato Security</a>
&nbsp;·&nbsp; <a href="https://twitter.com/SecurityYamato">@SecurityYamato</a>
</div>