浏览代码

chore(extra-plugin): statement plugin tag

JianBo He 4 年之前
父节点
当前提交
6a07c8ef6d
共有 1 个文件被更改,包括 9 次插入0 次删除
  1. 9 0
      lib-extra/README.md

+ 9 - 0
lib-extra/README.md

@@ -19,6 +19,15 @@ e.g. For an Erlang plugin named `plugin_foo`:
 }.
 }.
 ```
 ```
 
 
+Note: The `-emqx_plugin(?MODULE)` attribute should be added to
+`<plugin-name>_app.erl` file to indicate that this is an EMQ X Broker plugin.
+
+For example:
+```erlang
+%% plugin_foo_app.erl
+-emqx_plugin(?MODULE)
+```
+
 ## Build a release
 ## Build a release
 
 
 ```
 ```