From 6648675c075a91c3e8dc69aa5dae9d79d2b24764 Mon Sep 17 00:00:00 2001
From: James <32596618+ichiichi11@users.noreply.github.com>
Date: Sat, 24 Jul 2021 09:47:44 +0900
Subject: [PATCH] add usage (#38)

* add usage

* fix usage and adapt markdown lint  #26

Co-authored-by: Alan Smithee <nextsasasa@gmail.com>
---
 README.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 47c449a..9bfc1d1 100644
--- 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を称賛しています。
\ No newline at end of file
+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
+``````````