Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
phrp720 committed Jan 22, 2025
1 parent 7f65f4c commit 1fbbeef
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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()` |
Expand Down

0 comments on commit 1fbbeef

Please sign in to comment.