Skip to content

Commit

Permalink
feat: update README.md (change asdf to mise)
Browse files Browse the repository at this point in the history
  • Loading branch information
x86taka committed Nov 12, 2024
1 parent f1d241d commit 445281d
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
```

0 comments on commit 445281d

Please sign in to comment.