@taqueria/plugin-helloworld 0.42.3 → 0.42.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Hello World Plugin for Taqueria
|
|
2
|
+
|
|
3
|
+
The Hello World plugin provides a basic example of a Taqueria plugin. This plugin is intended to be used as a template for creating new plugins.
|
|
4
|
+
|
|
5
|
+
It is written in TypeScript and compiled to a JavaScript bundle for NodeJS using [tsup](https://github.com/egoist/tsup) and uses the `@taqueria/node-sdk` - as are all plugins that the Pinnacle Labs team develops for Taqueria.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- Taqueria v0.42.0 or later
|
|
10
|
+
- Node.js v18.18.0 or later
|
|
11
|
+
|
|
12
|
+
## Building
|
|
13
|
+
|
|
14
|
+
To build the Hello World plugin, run the following command from the root of this repository:
|
|
15
|
+
|
|
16
|
+
```shell
|
|
17
|
+
npm run build -w taqueria-plugin-helloworld
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
To install the Hello World plugin on a Taqueria project, navigate to the project folder and run:
|
|
23
|
+
|
|
24
|
+
```shell
|
|
25
|
+
cd [taqueria-project]
|
|
26
|
+
taq init # if the project isn't already initialized
|
|
27
|
+
taq install /path/to/taqueria-repo/taqueria-plugin-helloworld
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Usage:
|
|
31
|
+
|
|
32
|
+
The Hello World plugin provides a single command to Taqueria: `taq hello`.
|
|
33
|
+
|
|
34
|
+
## Plugin Development
|
|
35
|
+
|
|
36
|
+
We suggest cloning our hello-world plugin and using as a boilerplate.
|
|
37
|
+
|
|
38
|
+
See the following documentation from our Taqueria website, [taqueria.io](https://taqueria.io):
|
|
39
|
+
- [Building a Taqueria Plugin](https://taqueria.io/docs/taqueria-dev/making-plugins/)
|
|
40
|
+
- [Taqueria Architecture](https://taqueria.io/docs/taqueria-internals/architecture/)
|