Skip to content

Commit

Permalink
docs: improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JimMoen committed May 6, 2024
1 parent 977751d commit e72fce2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ This is a [rebar3 template](https://rebar3.org/docs/tutorials/templates/#custom-

This plugin template is for EMQX >= 5.0.

We introduced a AVRO config schema mechanism for plugins in EMQX 5.7.0 to facilitate configuration updates for plugins at runtime via RESTAPI.
Please see [priv/config_schmea.avsc.example](./priv/config_schmea.avsc.example) and [priv/config_i18n.json.example](./priv/config_schmea.avsc.example) as examples.

For EMQX >= 4.3, please see branch emqx-v4

For older EMQX versions, plugin development is no longer maintained.
Expand All @@ -27,9 +30,12 @@ $ rebar3 new emqx-plugin my_emqx_plugin
$ make -C my_emqx_plugin rel
```

**NOTE**
If the `REBAR_CACHE_DIR` environment variable has been set, the directory for templates should be `$REBAR_CACHE_DIR/.config/rebar3/templates`.
[Here](https://github.com/erlang/rebar3/issues/2762) is a relevant issue.
> [!NOTE]
> In order to use the AVRO config schema feature, please make sure the plugin template tag version >= 5.7.0
> [!NOTE]
> If the `REBAR_CACHE_DIR` environment variable has been set, the directory for templates should be `$REBAR_CACHE_DIR/.config/rebar3/templates`.
> [Here](https://github.com/erlang/rebar3/issues/2762) is a relevant issue.
This will create a tarball containing your custom plugin. You can use EMQX's Dashboard or it's command line tools to deploy it into your running EMQX cluster.

Expand Down

0 comments on commit e72fce2

Please sign in to comment.