Skip to content

Commit

Permalink
doc:update
Browse files Browse the repository at this point in the history
  • Loading branch information
phrp720 committed Jan 22, 2025
1 parent f9a3805 commit 2c7e3f6
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# aw-sync-agent-plugins
<h1 align="center">aw-sync-agent-plugins</h1>

## 🔍 About
This is a Repository that hosts the plugins of aw-sync-suite Agent.

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.

## Plugins
## ⚙️ Plugins


| Plugin | Description | Has Config | Config File |
Expand All @@ -13,7 +14,7 @@ Plugins of aw-sync-suite Agent are used to extend the functionality of the agent



## How to write a plugin
## 🛠️ How to create a plugin

### Core Plugin Structure

Expand All @@ -29,3 +30,10 @@ Inside this folder you should contain the plugin implementation idea which will
| `ReplicateConfig` | `ReplicateConfig(path string)` |
| `RawName` | `RawName() string` |
| `Name` | `Name() string` |


## 📝 License

This project is licensed under the **MIT license**.

See [LICENSE](https://github.com/phrp720/aw-sync-suite/blob/master/LICENSE) for more information.

0 comments on commit 2c7e3f6

Please sign in to comment.