init

README.md

@@ -0,0 +1,41 @@
+# provider-zexlab
+
+Zexlab provider for [go-semantic-release](https://github.com/go-semantic-release/semantic-release).
+
+This plugin is based on [provider-gitea](https://github.com/go-semantic-release/provider-gitea) and is tailored specifically for the Zexlab Gitea instance.
+
+## Provider Options
+
+The provider options can be configured via the `--provider-opt` CLI flag.
+
+| Name | Description | Example |
+|---|---|---|
+| server_url | Gitea server url (default: `https://zexlab.dev`) | `--provider-opt server_url=https://gitea.example.com` |
+| slug | The owner and repository name | `--provider-opt slug=owner/my-repo` |
+| token | Personal Access Token | `--provider-opt token=xxx` |
+| strip_v_tag_prefix | Strip "v" from release tag prefix (default: false) | `--provider-opt strip_v_tag_prefix=true` |
+
+## Usage
+
+```
+semantic-release \
+  --provider provider-zexlab \
+  --provider-opt slug=owner/my-repo \
+  --provider-opt token=your-token
+```
+
+## Building
+
+```
+make build
+```
+
+## Testing
+
+```
+make test
+```
+
+## Licence
+
+The [MIT License (MIT)](http://opensource.org/licenses/MIT)