From 9273861d554e5801d7f69da452ad54e774d4dc60 Mon Sep 17 00:00:00 2001
From: Tanaka Zakku <71482215+YamatoSecurity@users.noreply.github.com>
Date: Sat, 6 Nov 2021 08:14:27 +0900
Subject: [PATCH] =?UTF-8?q?Readme=E3=81=AE=E6=9B=B4=E6=96=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README-English.md | 126 +++++++
README-Japanese.md | 125 +++++++
README.md | 84 +----
...LEFILE.md => AboutRuleCreation-English.md} | 0
doc/AboutRuleCreation-Japanese.md | 315 ++++++++++++++++++
hayabusa-logo.png | Bin 0 -> 59392 bytes
6 files changed, 569 insertions(+), 81 deletions(-)
create mode 100644 README-English.md
create mode 100644 README-Japanese.md
rename doc/{RULEFILE.md => AboutRuleCreation-English.md} (100%)
create mode 100644 doc/AboutRuleCreation-Japanese.md
create mode 100644 hayabusa-logo.png
diff --git a/README-English.md b/README-English.md
new file mode 100644
index 00000000..9ca30054
--- /dev/null
+++ b/README-English.md
@@ -0,0 +1,126 @@
+
+
+
+ 
+
+
+
+
+# Hayabusa
+Hayabusa is a very fast Windows event analyzer used for creating forensic timelines and performing threat hunting based on IoCs written in either hayabusa or SIGMA rules. It can be run live, offline, pushed out as agents to be run on endpoints in an enterprise after an incident or even periodically reporting back alerts on slack.
+
+# About Hayabusa
+Hayabusa ("falcon" in Japanese) was written by the Yamato Security group in Japan. First inspired by the DeepblueCLI Windows event log analyzer, we started in 2020 porting it over to Rust for the RustyBlue project, then created SIGMA-like flexible signatures based in YAML, and then added a backend to SIGMA to support converting SIGMA rules into hayabusa rules. Supporting multi-threading, (to our knowledge) it is currently the fastest forensics timeline generator and threat hunting tool as well supports the most features in SIGMA. It can analyze multiple Windows event logs and consolidate the results into one timeline for easy analysis. It will output in CSV to be imported into tools like Timeline Explorer and Excel for analysis.
+
+# Screenshots
+Add screenshots here.
+
+# Features
+* Cross-platform support: Windows, Linux, macOS (Intel + ARM)
+* Faster than a hayabusa falcon!
+* English and Japanese support
+* Multi-thread support
+* Enterprise-wide threat hunting via alerts to Slack
+* Creating event timelines for forensic investigations and incident response
+* Threat hunting based on IoC signatures written in easy to read/create/edit YAML based hayabusa rules
+* SIGMA support to convert SIGMA rules to hayabusa rules
+* Event log statistics (Useful for getting a picture of what types of events there are and for tuning your log settings)
+
+# Downloads
+You can download pre-compiled binaries for the Windows, Linux and macOS at [Releases.](https://github.com/Yamato-Security/hayabusa/releases)
+
+# Usage
+## Command line options
+````
+USAGE:
+ hayabusa.exe [FLAGS] [OPTIONS]
+
+FLAGS:
+ --credits Prints a list of contributors
+ -h, --help Prints help information
+ --rfc-2822 Output date and time in RFC 2822 format. Example: Mon, 07 Aug 2006 12:34:56 -0600
+ --slack Sends alerts to Slack
+ -s, --statistics Prints statistics for event logs
+ -u, --utc Output time in UTC format (default: local time)
+ -V, --version Prints version information
+
+OPTIONS:
+ --csv-timeline