@taqueria/plugin-ligo 0.0.8 → 0.1.2

package/README.md

@@ -1,5 +1,31 @@
 # Taqueria LIGO Plugin
 
-This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK.
+This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
 
-The plugin provides a `compile` task used for compiling LIGO smart contracts to Michelson.
+The LIGO plugin exposes a compile task in Taqueria which can target one, or all the LIGO contracts in the contracts folder and compile them to Michelson code output to the artifacts folder
+
+## Tasks
+
+The LIGO plugin provides the following tasks to Taqueria:
+- `compile`
+
+## Requirements
+
+- Taqueria v0.0.6 or later
+- Node.js v16 or later
+- Docker v0.8.4 or later
+
+## Installation
+
+The LIGO plugin is distributed as an NPM package that can be installed and uninstalled on a project from the Taqueria CLI
+
+To install the LIGO plugin on a Taqueria project, navigate to the project folder and run:
+```shell
+taq install @taqueria/plugin-ligo
+```
+
+## Plugin Architecture
+
+This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
+
+For detailed usage and configuration information, view the LIGO plugin documentation on the Taqueria website [here](https://taqueria.io/docs/plugins/plugin-ligo) 

package/compile.js

@@ -14,7 +14,7 @@ const getInputFilename = (opts) => sourceFile => {
 const getCompileCommand = (opts, _arch) => (sourceFile) => {
     const {projectDir} = opts
     const inputFile = getInputFilename (opts) (sourceFile)
-    const baseCommand = `docker run --rm -v \"${projectDir}\":/project -w /project ligolang/ligo:next compile contract ${inputFile}`
+    const baseCommand = `DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run --rm -v \"${projectDir}\":/project -w /project ligolang/ligo:next compile contract ${inputFile}`
     const entryPoint = opts.e ? `-e ${opts.e}` : ""
     const syntax = opts["-s"] ? `s ${opts['s']} : ""` : ""
     const outFile = `-o ${getContractArtifactFilename(opts)(sourceFile)}`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taqueria/plugin-ligo",
-  "version": "0.0.8",
+  "version": "0.1.2",
   "description": "A taqueria plugin for compiling LIGO smart contracts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -34,6 +34,6 @@
   "homepage": "https://github.com/ecadlabs/taqueria#readme",
   "dependencies": {
     "fast-glob": "^3.2.7",
-    "@taqueria/node-sdk": "^0.0.5"
+    "@taqueria/node-sdk": "^0.1.1"
   }
 }