Skip to content

Commit 2201125

Browse files
committed
update readme
1 parent 7bf289b commit 2201125

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
# vfox-plugin-template
1+
# vfox-python
2+
Python plugin for [vfox](https://vfox.lhan.me/).
23

3-
This is a [vfox plugin](https://vfox.lhan.me/plugins/create/howto.html) template with CI that package and publish the plugin.
44

5-
## Usage
5+
## Install
66

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).
7+
After installing [vfox](https://github.com/version-fox/vfox), install the plugin by running:
108

11-
12-
## How to publish?
13-
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).
9+
```bash
10+
vfox install python
11+
```

0 commit comments

Comments
 (0)