From 1fbbeef6905c9d5dcf6c295ee48705a88e11ade5 Mon Sep 17 00:00:00 2001 From: phrp Date: Wed, 22 Jan 2025 02:48:01 +0100 Subject: [PATCH] readme update --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 59c8f51..297df44 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,28 @@ # aw-sync-agent-plugins -Repository that hosts the plugins of aw-sync-suite Agent +This is a Repository that hosts the plugins of aw-sync-suite Agent. ## Plugins 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 in the aggregation stage. + +| Plugin | Description | Has Config | Config File | +|-----------|-------------------------------------|------------|------------------------| +| `filters` | `Filters the data of ActivityWatch` | ✅ | `aw-plugin-filtes.yml` | + + + +## How to write a plugin + ### Core Plugin Structure +To write a plugin, you need to create a Go folder in the `plugins` directory. +Inside this folder you should contain the plugin implementation idea which will implements the `Plugin` interface as a core of the plugin. + +```go + | Method | Signature | |-------------------|-------------------------------------------------------------------------------| | `Initialize` | `Initialize()` |