Skip to content

Commit 7fe91cf

Browse files
authored
doc: update
1 parent f27163f commit 7fe91cf

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This is a Repository that hosts the plugins of aw-sync-suite [Agent](https://git
1515

1616
Plugins of aw-sync-suite Agent are used to extend the functionality of the agent. The plugins are written in Go and are executed by the agent during the aggregation stage.
1717

18-
## ⚙️ Plugins
18+
## ⚙️ Available Plugins
1919

2020

2121
| Plugin | Description | Has Config | Config File |
@@ -26,21 +26,11 @@ Plugins of aw-sync-suite Agent are used to extend the functionality of the agent
2626

2727
## 🛠️ How to create a plugin
2828

29-
### Core Plugin Structure
29+
For instructions on creating a plugin, please refer [here](https://github.com/phrp720/aw-sync-suite-plugins/wiki/%F0%9F%93%9D-How-to-Create-a-Plugin).
3030

31-
To write a plugin, you need to create a Go folder in the `plugins` directory.
32-
Inside this folder you should contain the plugin implementation idea which will implements the `Plugin` interface as a core of the plugin.
33-
34-
35-
36-
| Method | Signature | Description |
37-
|-------------------|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
38-
| `Initialize` | `Initialize()` | Initialization of the plugin (Before the aw data) |
39-
| `Execute` | `Execute(watcher string, events Events, userID string, includeHostName bool)` | Execution of the plugin (While having the aw data) |
40-
| `ReplicateConfig` | `ReplicateConfig(path string)` | Replicate the plugin config (for service purposes) |
41-
| `RawName` | `RawName() string` | Get the raw name of the plugin (module name) |
42-
| `Name` | `Name() string` | Get the name of the configuration of the plugin (with prefix `aw-plugin-{RawName}.yaml` |
31+
## 🔗 How to integrate a plugin
4332

33+
For instructions on integrating a plugin, please refer [here](https://github.com/phrp720/aw-sync-suite-plugins/wiki/%F0%9F%9B%A0%EF%B8%8F--How-to-Integrate-a-Plugin).
4434

4535
## 📝 License
4636

0 commit comments

Comments
 (0)