Merge pull request #2 from nttcom/add-package-manager-to-readme

add package manager to readme
nttcom · Sep 25, 2023 · 5fc094c · 5fc094c
2 parents 43c1cf9 + 43b85ac
commit 5fc094c
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,17 @@ English is [here](https://github.com/nttcom/zeek-parser-DHCPV6/blob/main/README_
 
 Zeek-Parser-DHCPv6-COMとはDHCPv6(Dynamic Host Configuration Protocol for IPv6)を解析できるZeekプラグインです。
 
-## 使い方
+## インストール
+
+### パッケージマネージャーによるインストール
+
+このプラグインは[Zeek Package Manger](https://docs.zeek.org/projects/package-manager/en/stable/index.html)用のパッケージとして提供されています。
+
+以下のコマンドを実行することで、本プラグインは利用可能になります。
+```
+zkg refresh
+zkg install zeek-parser-DHCPv6-COM
+```
 
 ### マニュアルインストール
 
@@ -32,6 +42,18 @@ spicyc v1.5.0 (d0bc6053)
 ~$ git clone https://github.com/nttcom/zeek-parser-DHCPV6-COM.git
 ```
 
+## 使い方
+
+### パッケージマネージャーによるインストールの場合
+
+以下のように本プラグインを使うことで `dhcpv6.log` が生成されます。
+
+```
+zeek -Cr /usr/local/zeek/var/lib/zkg/clones/package/zeek-parser-DHCPv6-COM/testing/Traces/test.pcap zeek-parser-DHCPv6-COM
+```
+
+### マニュアルインストールの場合
+
 ソースコードをコンパイルして、オブジェクトファイルを以下のパスにコピーします。
 ```
 ~$ cd ~/zeek-parser-DHCPV6-COM/analyzer

diff --git a/README_en.md b/README_en.md
@@ -4,7 +4,18 @@
 
 Zeek-Parser-DHCPv6-COM is a Zeek plug-in that can analyze communication using DHCPv6(Dynamic Host Configuration Protocol for IPv6).
 
-## Usage
+## Installation
+
+### Installation with Package Manager
+
+This plug-in is provided as a package for [Zeek Package Manger](https://docs.zeek.org/projects/package-manager/en/stable/index.html).
+
+It can be installed by executing the commands below.
+
+```
+zkg refresh
+zkg install zeek-parser-DHCPv6-COM
+```
 
 ### Manual Installation
 
@@ -31,6 +42,18 @@ Use `git clone` to get a copy of this repository to your local environment.
 ~$ git clone https://github.com/nttcom/zeek-parser-DHCPV6-COM.git
 ```
 
+## Usage
+
+### For installation using a package manager
+
+`dhcpv6.log` will be generated by the command below:
+
+```
+zeek -Cr /usr/local/zeek/var/lib/zkg/clones/package/zeek-parser-DHCPv6-COM/testing/Traces/test.pcap zeek-parser-DHCPv6-COM
+```
+
+### For manual installation
+
 Compile source code and copy the object files to the following path.
 ```
 ~$ cd ~/zeek-parser-DHCPV6-COM/analyzer