@taqueria/plugin-archetype 0.0.0-pr-726-e060c010 → 0.0.0-pr-575-850bfda7

package/README.md

@@ -1,30 +1,55 @@
-# Taqueria Archetype Plugin
+# Archetype Plugin
 
 This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
 
-The Archetype plugin exposes a compile task in Taqueria which can target one, or all the Archetype contracts in the contracts folder and compile them to Michelson code output to the artifacts folder
-
-## Tasks
-
-The Archetype plugin provides the following tasks to Taqueria:
-- `compile`
+The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files
 
 ## Requirements
 
-- Taqueria v0.0.6 or later
 - Node.js v16 or later
+- Docker v0.8.2 or later
 
 ## Installation
 
-The Archetype plugin is distributed as an NPM package that can be installed and uninstalled on a project from the Taqueria CLI
-
 To install the Archetype plugin on a Taqueria project, navigate to the project folder and run:
 ```shell
 taq install @taqueria/plugin-archetype
 ```
 
+> ### :page_with_curl: Note
+> At this time, all Taqueria projects must also be initialized as node projects by running `npm init -y` from the root of your project directory
+
+## Configuration
+
+No additional configuration is available
+
+## Usage
+
+The Archetype plugin exposes a `compile` task in Taqueria which can target one, or all the Archetype contracts in the `contracts` folder and compile them to Michelson `.tz` files output to the `artifacts` folder
+
+### Running the Compile Task
+
+The Archetype plugin's `taq compile` task can be run with or without arguments. The basic syntax for the task is `taq compile <file-name>`
+
+Running the `compile` task with no options will result in all source Archetype smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you speficy an optional filename, only Archetype contracts matching the specified filename in the `contracts` folder will be compiled
+
+> ### :warning: CAUTION
+> The `compile` task can be implemented by more than one compiler plugin installed on a project (Archetype, LIGO, SmartPY). If this is the case, you must use the `--plugin Archetype` flag to specify a particular compiler. For example `taq compile --plugin archetype`
+
+### Options
+
+There are no additional options available for this plugin
+
 ## Plugin Architecture
 
-This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
+This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
+
+Docker is used under the hood to provide a self contained environment for Archetype to prevent the need for it to be installed on the user's local machine
+
+The plugin provides a single task `compile`, used for compiling Archetype smart contracts to Michelson:
 
-For detailed usage and configuration information, view the Archetype plugin documentation on the Taqueria website [here](https://taqueria.io/docs/plugins/plugin-archetype)
+|  attribute |  value                        | 
+|------------|:-----------------------------:|
+|  task      | 'compile'                     | 
+|  command   | 'compile [sourceFile]         | 
+|  aliases   | ['c', 'compile-archetype']    |  

package/_readme.eta

@@ -0,0 +1,59 @@
+<% if (it.output == "github") { %>
+# Archetype Plugin
+<% } %>
+
+This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
+
+The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files
+
+## Requirements
+
+- Node.js v16 or later
+- Docker v0.8.2 or later
+
+## Installation
+
+To install the Archetype plugin on a Taqueria project, navigate to the project folder and run:
+```shell
+taq install @taqueria/plugin-archetype
+```
+
+<%~ it.noteOpenAdmonition %>
+At this time, all Taqueria projects must also be initialized as node projects by running `npm init -y` from the root of your project directory
+<%~ it.closeAdmonition %>
+
+## Configuration
+
+No additional configuration is available
+
+## Usage
+
+The Archetype plugin exposes a `compile` task in Taqueria which can target one, or all the Archetype contracts in the `contracts` folder and compile them to Michelson `.tz` files output to the `artifacts` folder
+
+### Running the Compile Task
+
+The Archetype plugin's `taq compile` task can be run with or without arguments. The basic syntax for the task is `taq compile <file-name>`
+
+Running the `compile` task with no options will result in all source Archetype smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you speficy an optional filename, only Archetype contracts matching the specified filename in the `contracts` folder will be compiled
+
+<%~ it.cautionOpenAdmonition %>
+The `compile` task can be implemented by more than one compiler plugin installed on a project (Archetype, LIGO, SmartPY). If this is the case, you must use the `--plugin Archetype` flag to specify a particular compiler. For example `taq compile --plugin archetype`
+<%~ it.closeAdmonition %>
+
+### Options
+
+There are no additional options available for this plugin
+
+## Plugin Architecture
+
+This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
+
+Docker is used under the hood to provide a self contained environment for Archetype to prevent the need for it to be installed on the user's local machine
+
+The plugin provides a single task `compile`, used for compiling Archetype smart contracts to Michelson:
+
+|  attribute |  value                        | 
+|------------|:-----------------------------:|
+|  task      | 'compile'                     | 
+|  command   | 'compile [sourceFile]         | 
+|  aliases   | ['c', 'compile-archetype']    |  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taqueria/plugin-archetype",
-  "version": "0.0.0-pr-726-e060c010",
+  "version": "0.0.0-pr-575-850bfda7",
   "description": "A taqueria plugin for compiling Archetype smart contracts",
   "targets": {
     "default": {