Skip to content

Commit e32831d

Browse files
committed
Add logo
1 parent a2e888b commit e32831d

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
# gatewayd-plugin-js
1+
<p align="center">
2+
<a href="https://docs.gatewayd.io/plugins/gatewayd-plugin-js">
3+
<picture>
4+
<img alt="gatewayd-plugin-js-logo" src="https://github.com/gatewayd-io/gatewayd-plugin-js/blob/main/assets/gatewayd-plugin-js-logo.png" width="96" />
5+
</picture>
6+
</a>
7+
<h3 align="center">gatewayd-plugin-js</h3>
8+
<p align="center">GatewayD plugin for running JS functions as hooks.</p>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/gatewayd-io/gatewayd-plugin-js/releases">Download</a> ·
13+
<a href="https://docs.gatewayd.io/plugins/gatewayd-plugin-js">Documentation</a>
14+
</p>
15+
16+
## Features
17+
18+
- Run JS functions as hooks
19+
- Helper functions for common tasks such as parsing incoming queries
20+
- Support for running multiple JS functions as hooks
21+
- Prometheus metrics for monitoring
22+
23+
## Build for testing
24+
25+
To build the plugin for development and testing, run the following command:
26+
27+
```bash
28+
make build-dev
29+
```
30+
31+
Running the above command causes the `go mod tidy` and `go build` to run for compiling and generating the plugin binary in the current directory, named `gatewayd-plugin-js`.
32+
33+
> [!WARNING]
34+
> This plugin is experimental and is not recommended for production use. This is unless you know what you are doing.
235
3-
Use this template to create your own plugin.

assets/gatewayd-plugin-js-logo.png

5.33 KB
Loading

0 commit comments

Comments
 (0)