From 445281df2dd8dc7910f7393de58014e64afcf85b Mon Sep 17 00:00:00 2001 From: t-umeda Date: Tue, 12 Nov 2024 13:11:41 +0900 Subject: [PATCH] feat: update README.md (change asdf to mise) --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 130ab6a..ba193d3 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,40 @@ # xk6-gtp -Client extension for interacting with a use GTP proto of your k6 test. -🚧 This project WIP... 🚧 +Client extension for interacting with a GTP protocol in your k6 test. -## Prepair -require asdf installed. -[how to asdf install](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf) +🚧 This project is a WIP... 🚧 + +## Preparation + +Requires packages and tools. + +- [mise](https://github.com/jdx/mise) Install tools required for development. + ```shell= make install-dev-pkg ``` ## Build + ```shell= make install-go-tools make build ``` -## Test Running +## Running Tests + ```shell ./out/bin/xk6 run example/echo-stress.js ./out/bin/pgw ``` -## Support scenario +## Supported Scenarios + ### GTPv2-C + - [x] Node monitoring (Echo Request/Echo Response) - [x] Create Session (Create Session Request/Create Session Response) - [x] sgw->pgw scenario @@ -36,21 +44,21 @@ make build - [x] sgw->pgw scenario - [ ] Delete Bearer (Delete Bearer Request/Delete Bearer Response) +## Special Thanks -## Special thanks -This PoC takes full advantage of [go-gtp](https://github.com/wmnsk/go-gtp). Thanks to the @wmnsk and developer all. +This PoC takes full advantage of [go-gtp](https://github.com/wmnsk/go-gtp). Thanks to @wmnsk and all developers. ## Developers Settings ```shell -# fmt, lint, commitmessage validate...etc checker +# Format, lint, commit message validation, etc. pre-commit install -# mob programing +# Mob programming co-author hook > .git/hooks/prepare-commit-msg chmod +x .git/hooks/prepare-commit-msg -# create docker image +# Create Docker image make docker-build make docker-release ```