Skip to content

Commit b4f045d

Browse files
committed
docs: use codefences for syntax highlighting
1 parent cdc5b62 commit b4f045d

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,36 @@ Version: 0.0.9
66

77
We recommend to use [pipx](https://pypa.github.io/pipx/):
88

9-
pipx install beku-stackabletech
9+
```sh
10+
pipx install beku-stackabletech
11+
```
1012

1113
But you can also use `pip`:
1214

13-
# from PyPI
14-
pip install beku-stackabletech
15-
# from GitHub
16-
pip install git+https://github.com/stackabletech/beku.py.git@master
15+
```sh
16+
# from PyPI
17+
pip install beku-stackabletech
18+
# from GitHub
19+
pip install git+https://github.com/stackabletech/beku.py.git@master
20+
```
1721

1822
## Usage
1923

20-
cd <stackable operator directory>
21-
rm -rf tests/_work && beku
22-
cd tests/_work && kubectl kuttl test
24+
```sh
25+
cd <stackable operator directory>
26+
rm -rf tests/_work && beku
27+
cd tests/_work && kubectl kuttl test
28+
```
2329

2430
Also see the `examples` folder.
2531

2632
## Description
2733

2834
Fast Kuttl tests expander for Stackable integration tests.
2935

30-
beku -i tests/test-definition.yaml -t tests/templates/kuttl -k tests/kuttl-test.yaml.jinja2 -o tests/_work
36+
```sh
37+
beku -i tests/test-definition.yaml -t tests/templates/kuttl -k tests/kuttl-test.yaml.jinja2 -o tests/_work
38+
```
3139

3240
## Release a new version
3341

@@ -41,6 +49,8 @@ Update the CHANGELOG.
4149
Commit and tag.
4250
Build and publish:
4351

44-
rm -rf dist/
45-
python -m build --wheel .
46-
twine upload dist/*
52+
```sh
53+
rm -rf dist/
54+
python -m build --wheel .
55+
twine upload dist/*
56+
```

0 commit comments

Comments
 (0)