From 786faf3b30819b1e51f3af161bda699b7ad152b7 Mon Sep 17 00:00:00 2001 From: Jason Lee Date: Fri, 17 Nov 2023 10:59:54 +0800 Subject: [PATCH] update README.md --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0e4fc49..00b77c5 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,6 @@ make ``` The Makefile will automatically download [xk6](https://github.com/grafana/xk6), which is required to compile this project. -## Generator -`bin/dict_generator` is used to generate `diam/const.js`, which contains a list of AVP codes and vendor IDs. - -```bash -./bin/dict_generator -output example/diam/const.js -``` - ## Example ```js @@ -55,3 +48,17 @@ Use your custom k6 binary to run an example k6 script. ```bash ./bin/k6 run example/example.js ``` + +## Generator + +There are thousands of AVPs, each with a unique avp-code and vendor-id. To aid readability and enhance the developer experience, we recommend defining them as constants in a separate file, for example, using `diam/const.js`. + +You can either create the constant yourself or use the bin/dict_generator CLI tool to generate a full list of AVPs for you. Use the following command: +```bash +./bin/dict_generator -output example/diam/const.js +``` + +The CLI also supports generating additional AVPs that are not defined in the default list. Simply add the -dictionary flag to include the additional AVP definition: +```bash +./bin/dict_generator -output example/diam/const.js -dictionary dict/extra.xml +```