diff --git a/README.md b/README.md index 9687936..67eaf36 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ This template must be used with the AsyncAPI Generator. You can find all availab npm install -g @asyncapi/generator # Run generation -ag https://ibm.biz/mq-asyncapi-yml-sample https://ibm.biz/asyncapi-java-template -o output -p server=production +ag https://ibm.biz/mq-asyncapi-yml-sample @asyncapi/java-template -o output -p server=production ``` ### Template Tutorial @@ -78,6 +78,8 @@ Name | Description | Required | Default `password` | Password for the server to generate code for. This can also be provided as an environment variable (see below) | No | passw0rd `package` | Java package name for generated code | No | com.ibm.mq.samples.jms `mqTopicPrefix` | MQ topic prefix. Used for ibmmq protocols. Default will work with dev MQ instance | No | dev// +`asyncapiFileDir` | Custom output location of the AsyncAPI file that you provided as an input | No | The root of the output directory + ## Environment variables @@ -94,7 +96,7 @@ All credentials are stored in `env.json` in the output directory, so they can be The most straightforward command to use this template is: ```sh -ag https://ibm.biz/mq-asyncapi-yml-sample https://ibm.biz/asyncapi-java-template -o output -p server=production +ag https://ibm.biz/mq-asyncapi-yml-sample @asyncapi/java-template -o output -p server=production ``` For local development, you need different variations of this command. First of all, you need to know about three important CLI flags: @@ -107,13 +109,13 @@ There are two ways you can work on template development: - Use global Generator and template from your local sources: ```sh # assumption is that you run this command from the root of your template - ag https://ibm.biz/mq-asyncapi-yml-sample https://ibm.biz/asyncapi-java-template -o output -p server=production + ag https://ibm.biz/mq-asyncapi-yml-sample @asyncapi/java-template -o output -p server=production ``` - Use Generator from sources and template also from local sources. This approach enables more debugging options with awesome `console.log` in the Generator sources or even the Parser located in `node_modules` of the Generator: ```sh # assumption is that you run this command from the root of your template # assumption is that generator sources are cloned on the same level as the template - ../generator/cli.js https://ibm.biz/mq-asyncapi-yml-sample https://ibm.biz/asyncapi-java-template -o output -p server=production + ../generator/cli.js https://ibm.biz/mq-asyncapi-yml-sample @asyncapi/java-template -o output -p server=production ``` ## Key Files diff --git a/tutorials/IBMMQ.md b/tutorials/IBMMQ.md index 523bd9d..6fe754c 100644 --- a/tutorials/IBMMQ.md +++ b/tutorials/IBMMQ.md @@ -32,7 +32,7 @@ cd ~/asyncapi-java-tutorial These commands will allow you to run the Java Template publisher/subscriber model using IBM MQ. 1. Run the AsyncAPI Generator.
**Note:** You may need to change the username and password values if you have not followed the IBM MQ tutorial. ``` - ag https://ibm.biz/mq-asyncapi-yml-sample https://ibm.biz/asyncapi-java-template -o ./output -p server=production -p user=app -p password=passw0rd + ag https://ibm.biz/mq-asyncapi-yml-sample @asyncapi/java-template -o ./output -p server=production -p user=app -p password=passw0rd ``` **Note:** The syntax of the above command is shown below. You do not need to run the below line, it is for informational purposes only. ``` diff --git a/tutorials/KAFKA.md b/tutorials/KAFKA.md index fa67039..7ebadd1 100644 --- a/tutorials/KAFKA.md +++ b/tutorials/KAFKA.md @@ -32,7 +32,7 @@ cd ~/asyncapi-java-tutorial These commands will allow you to run the Java Template publisher/subscriber model using IBM MQ. 1. Run the AsyncAPI Generator. ``` - ag https://ibm.biz/kafka-asyncapi-yml-sample https://ibm.biz/asyncapi-java-template -o ./output -p server=production + ag https://ibm.biz/kafka-asyncapi-yml-sample @asyncapi/java-template -o ./output -p server=production ``` **Note:** The syntax of the above command is shown below. You do not need to run the below line, it is for informational purposes only. ```