@taqueria/plugin-tzcompose 0.49.10 → 0.49.12

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.
Files changed (2) hide show
  1. package/README.md +21 -7
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Tzcompose Plugin for Taqueria
2
2
 
3
- This plugin provides integration with tzcompose, a tool by Blockwatch that provides an automation framework for complex transaction sequences on Tezos.
3
+ This plugin integrates [Tzcompose](https://github.com/blockwatch-cc/tzgo/blob/master/cmd/tzcompose/README.md), a powerful automation framework developed by Blockwatch for executing complex transaction sequences on Tezos, into the Taqueria development environment.
4
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.
5
+ The plugin is written in TypeScript and compiled to a JavaScript bundle for Node.js using [tsup](https://github.com/egoist/tsup). It leverages the `@taqueria/node-sdk`, following the same development practices as other plugins created by the Pinnacle Labs team for Taqueria.
6
6
 
7
7
  ## Requirements
8
8
 
@@ -11,7 +11,7 @@ It is written in TypeScript and compiled to a JavaScript bundle for NodeJS using
11
11
 
12
12
  ## Building
13
13
 
14
- To build the Tzcompose plugin, run the following command from the root of this repository:
14
+ To build the Tzcompose plugin, run the following command from the root of the plugin repository:
15
15
 
16
16
  ```shell
17
17
  npm run build -w taqueria-plugin-tzcompose
@@ -19,7 +19,7 @@ npm run build -w taqueria-plugin-tzcompose
19
19
 
20
20
  ## Installation
21
21
 
22
- To install the Tzcompose plugin on a Taqueria project, navigate to the project folder and run:
22
+ To install the Tzcompose plugin in a Taqueria project, navigate to the project folder and run:
23
23
 
24
24
  ```shell
25
25
  cd [taqueria-project]
@@ -27,8 +27,22 @@ taq init # if the project isn't already initialized
27
27
  taq install @taqueria/plugin-tzcompose
28
28
  ```
29
29
 
30
- ## Usage:
30
+ ## Usage
31
31
 
32
- The Tzcompose plugin provides a single command to Taqueria: `taq run [pipeline.yaml]`.
32
+ The Tzcompose plugin adds a single command to Taqueria:
33
33
 
34
- For more information of how to create a YAML file for your pipelines, please see the Tzcompose [[documentation]](https://github.com/blockwatch-cc/tzgo/blob/master/cmd/tzcompose/README.md).
34
+ ```shell
35
+ taq tzcompose [pipeline.yaml]
36
+ ```
37
+
38
+ This command runs the specified Tzcompose pipeline YAML file within your Taqueria project.
39
+
40
+ For detailed information on creating YAML files to define your Tzcompose pipelines, please refer to the [Tzcompose documentation](https://github.com/blockwatch-cc/tzgo/blob/master/cmd/tzcompose/README.md).
41
+
42
+ ## Contributing
43
+
44
+ Contributions to improve the Tzcompose plugin are welcome! Please submit issues and pull requests on the plugin's GitHub repository.
45
+
46
+ ## License
47
+
48
+ The Tzcompose plugin is open-source software licensed under the [Apache 2 License](../LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-tzcompose",
3
- "version": "0.49.10",
3
+ "version": "0.49.12",
4
4
  "description": "A TzCompose plugin for Taqueria using the GoTz SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -21,7 +21,7 @@
21
21
  "typescript": "^5.3.3"
22
22
  },
23
23
  "dependencies": {
24
- "@taqueria/node-sdk": "^0.49.10"
24
+ "@taqueria/node-sdk": "^0.49.12"
25
25
  },
26
26
  "tsup": {
27
27
  "entry": [