Skip to content

Commit 0513f20

Browse files
authored
docs: Update README.md following vfox-lua plugin format (#7)
1 parent 3129e3e commit 0513f20

1 file changed

Lines changed: 39 additions & 8 deletions

File tree

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,46 @@
1-
# vfox-plugin-template
1+
# vfox-chaosblade plugin
22

3-
This is a [vfox plugin](https://vfox.lhan.me/plugins/create/howto.html) template with CI that package and publish the plugin.
3+
ChaosBlade [vfox](https://github.com/version-fox) plugin. Use the vfox to manage multiple [ChaosBlade](https://github.com/chaosblade-io/chaosblade) versions on Linux.
4+
5+
ChaosBlade is an Alibaba open source chaos engineering toolkit that follows the principles of chaos engineering and chaos experimental models to help enterprises improve the fault tolerance of distributed systems and ensure business continuity during the process of enterprises going to cloud or moving to cloud native systems.
6+
7+
## Requirements
8+
9+
- Linux System (currently only Linux is supported)
410

511
## Usage
612

7-
1. [Generate](https://github.com/version-fox/vfox-plugin-template/generate) a new repository based on this template.
8-
2. Configure [metadata](https://github.com/version-fox/vfox-plugin-template/blob/main/metadata.lua) information
9-
3. To develop your plugin further, please read [the plugins create section of the docs](https://vfox.lhan.me/plugins/create/howto.html).
13+
```shell
14+
# install plugin
15+
vfox add --source https://github.com/vibe-ideas/vfox-chaosblade/archive/refs/heads/main.zip chaosblade
16+
17+
# search available chaosblade versions
18+
vfox search chaosblade
19+
20+
# install a specific chaosblade version
21+
vfox install chaosblade@1.7.4
22+
23+
# use a specific version
24+
vfox use chaosblade@1.7.4 -g
25+
26+
# verify installation
27+
blade version
28+
```
29+
30+
## Notice
31+
32+
1. ChaosBlade binaries will be installed to the vfox managed directory and automatically added to your PATH when activated.
33+
34+
2. The plugin sets the `CHAOSBLADE_HOME` environment variable to point to the installation directory.
35+
36+
## Known Issues
37+
38+
- Currently only supports Linux systems (Windows and macOS support not implemented yet)
39+
- Requires arm64 or amd64 architecture
1040

41+
## Acknowledgements
1142

12-
## How to publish?
43+
Thanks for these awesome resources that were used during the development of the **vfox-chaosblade**:
1344

14-
1. Push a new tag to the repository which name is `vX.Y.Z` (X.Y.Z is the version number).
15-
2. The CI will automatically package, then publish [release](https://github.com/version-fox/vfox-plugin-template/releases/tag/v0.0.1) and publish [manifest](https://github.com/version-fox/vfox-plugin-template/releases/tag/manifest).
45+
- [ChaosBlade](https://github.com/chaosblade-io/chaosblade) - An Easy to Use and Powerful Chaos Engineering Toolkit
46+
- [version-fox](https://github.com/version-fox/vfox) - A cross-platform and extendable version manager

0 commit comments

Comments
 (0)