add usage (#38)

* add usage * fix usage and adapt markdown lint #26 Co-authored-by: Alan Smithee <[email protected]>
Yamato-Security · Jul 24, 2021 · 6648675 · 6648675
1 parent 29cdae6
commit 6648675
Showing 1 changed file with 37 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,39 @@
-# RustyBlue 
+# RustyBlue
+
 RustyBlue is a software ported from DeepBlueCLI in Rust language. We admire the DeepBlueCLI.
 
-RustyBlueはDeepBlueCLIをRust言語で移植されたソフトです。私たちは、DeepBlueCLIを称賛しています。
+RustyBlueはDeepBlueCLIをRust言語で移植されたソフトです。私たちは、DeepBlueCLIを称賛しています。
+
+## Usage
+
+`````````````````````
+-f --filepath=[FILEPATH] 'analyze event file'
+-d --dirpath=[DIRECTORYPATH] 'analyze event log files in directory'
+-c --credits 'print credits infomation'
+`````````````````````
+
+## Usage Example
+
+### Analysis one event log for specified path
+
+コンパイルされたバイナリを使用する場合、下記のようなコマンドで実行することができます。
+
+``````````
+rusty_blue.exe --filepath=C:\Users\user\Downloads\security.evtx
+``````````
+
+### Analysis recusively all event logs in specified directory
+
+コンパイルされたバイナリを使用する場合、下記のようなコマンドで実行することができます。
+
+``````````
+rusty_blue.exe --dirpath=C:\Users\user\Downloads
+``````````
+
+### Build from source code
+
+以下コマンドでcloneしたソースコードからコンパイルすることができます。Rustのコンパイル環境をローカル環境に導入していることが条件です。
+
+``````````
+cargo build --release
+``````````