From 7b8d60fe1a78afa2463ef2369a90df796b2466bb Mon Sep 17 00:00:00 2001 From: Alan Smithee Date: Thu, 3 Feb 2022 23:24:32 +0900 Subject: [PATCH] updated readme #391 --- README-English.md | 9 ++++++++- README-Japanese.md | 8 ++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README-English.md b/README-English.md index 1e69f1c2..13fb5e27 100644 --- a/README-English.md +++ b/README-English.md @@ -79,7 +79,13 @@ You can download the latest Hayabusa version from the [Releases](https://github. You can also `git clone` the repository with the following command and compile binary from source code.: ```bash -git clone https://github.com/Yamato-Security/hayabusa.git --recursive +git clone https://github.com/Yamato-Security/hayabusa.git +``` + +You can get latest Hayabusa rules with the execute following command. + +```bash +.\hayabusa.exe -U ``` If you forget to use `--recursive` option, `rules/` files which managed in submodule did not cloned. @@ -129,6 +135,7 @@ USAGE: -v --verbose 'Output verbose information' -D --enable-deprecated-rules 'Enable sigma rules marked as deprecated' -n --enable-noisy-rules 'Enable rules marked as noisy' + -U --rule-update 'Clone latest hayabusa-rule' -m --min-level=[LEVEL] 'Minimum level for rules (default: informational)' --start-timeline=[STARTTIMELINE] 'Start time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00'' --end-timeline=[ENDTIMELINE] 'End time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00'' diff --git a/README-Japanese.md b/README-Japanese.md index 373cc6bd..e9d6b7b4 100644 --- a/README-Japanese.md +++ b/README-Japanese.md @@ -80,14 +80,13 @@ Hayabusaの[Releases](https://github.com/Yamato-Security/hayabusa/releases)か または、以下の`git clone`コマンドでレポジトリをダウンロードし、ソースコードからコンパイルして使用することも可能です。 ```bash -git clone https://github.com/Yamato-Security/hayabusa.git --recursive +git clone https://github.com/Yamato-Security/hayabusa.git ``` -`--recursive` をつけ忘れた場合、サブモジュールとして管理されている `rules/` 内のファイルが取得できません。 -以下のコマンドでサブモジュールを取得してください。 +Hayabusaでは検知ルールを`rules/`フォルダの取得はコンパイル後に以下のコマンドでルールの最新版を取得することができます。 ```bash -git submodule update --init +.\hayabusa.exe -U ``` # ソースコードからのコンパイル(任意) @@ -130,6 +129,7 @@ USAGE: -v --verbose 'Output verbose information' -D --enable-deprecated-rules 'Enable sigma rules marked as deprecated' -n --enable-noisy-rules 'Enable rules marked as noisy' + -U --rule-update 'Clone latest hayabusa-rule' -m --min-level=[LEVEL] 'Minimum level for rules (default: informational)' --start-timeline=[STARTTIMELINE] 'Start time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00'' --end-timeline=[ENDTIMELINE] 'End time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00''