Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hexagon committed Apr 25, 2024
1 parent a336147 commit ccffe2a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/examples/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ To create a custom plugin, developers should extend the `PluginImplementation` c

The plugin then communicates with Pup using `PupRestClient` from `@pup/api-client`. The url and credentials are passed to the plugin constructor.

Example (full example available at <https://github.com/Hexagon/pup/tree/main/docs/src/examples/plugins>):

```typescript
import { PupRestClient } from "jsr:@pup/api-client"
import { type PluginConfiguration, PluginImplementation } from "jsr:@pup/plugin"
Expand Down Expand Up @@ -157,3 +159,5 @@ The end user configuration for activating a plugin by `pup.json` is
]
}
```

Full example available at <https://github.com/Hexagon/pup/tree/main/docs/src/examples/plugins>.

0 comments on commit ccffe2a

Please sign in to comment.