asyncapi
diff --git a/‎.hooks/rename-gitignore.js
-9 b/‎.hooks/rename-gitignore.js
-9
diff --git a/‎.hooks/rename-package.js
-9 b/‎.hooks/rename-package.js
-9
diff --git a/‎.partials/channel.md
-21 b/‎.partials/channel.md
-21
diff --git a/‎.partials/channels.md
-7 b/‎.partials/channels.md
-7
diff --git a/‎.partials/content.md
-5 b/‎.partials/content.md
-5
diff --git a/‎.partials/info.md
-108 b/‎.partials/info.md
-108
diff --git a/‎.partials/message.md
-63 b/‎.partials/message.md
-63
diff --git a/‎.partials/operation.md
-18 b/‎.partials/operation.md
-18
diff --git a/‎.partials/parameters.md
-17 b/‎.partials/parameters.md
-17
diff --git a/‎.partials/schema-prop.md
-33 b/‎.partials/schema-prop.md
-33
diff --git a/‎.partials/schema.md
-25 b/‎.partials/schema.md
-25
diff --git a/‎.partials/tags.md
-5 b/‎.partials/tags.md
-5
diff --git a/‎README.md
+25-2 b/‎README.md
+25-2
diff --git a/‎.filters/all.js ‎filters/all.js b/‎.filters/all.js ‎filters/all.js
diff --git a/‎.hooks/create-asyncapi-file.js ‎hooks/create-asyncapi-file.js b/‎.hooks/create-asyncapi-file.js ‎hooks/create-asyncapi-file.js
diff --git a/‎.editorconfig ‎template/.editorconfig b/‎.editorconfig ‎template/.editorconfig
diff --git a/‎.eslintrc ‎template/.eslintrc b/‎.eslintrc ‎template/.eslintrc
diff --git a/‎__.gitignore ‎template/.gitignore b/‎__.gitignore ‎template/.gitignore
diff --git a/‎.npmignore ‎template/.npmignore b/‎.npmignore ‎template/.npmignore
diff --git a/‎Dockerfile ‎template/Dockerfile b/‎Dockerfile ‎template/Dockerfile
diff --git a/‎template/README.md
+3 b/‎template/README.md
+3
diff --git a/‎config/common.yml ‎template/config/common.yml b/‎config/common.yml ‎template/config/common.yml
diff --git a/‎__package.json ‎template/package.json b/‎__package.json ‎template/package.json
diff --git a/‎src/api/handlers/$$channel$$.js ‎template/src/api/handlers/$$channel$$.js b/‎src/api/handlers/$$channel$$.js ‎template/src/api/handlers/$$channel$$.js
diff --git a/‎src/api/index.js ‎template/src/api/index.js b/‎src/api/index.js ‎template/src/api/index.js
diff --git a/‎src/api/middlewares/buffer2string.js ‎template/src/api/middlewares/buffer2string.js b/‎src/api/middlewares/buffer2string.js ‎template/src/api/middlewares/buffer2string.js
diff --git a/‎src/api/middlewares/error-logger.js ‎template/src/api/middlewares/error-logger.js b/‎src/api/middlewares/error-logger.js ‎template/src/api/middlewares/error-logger.js
diff --git a/‎src/api/middlewares/json2string.js ‎template/src/api/middlewares/json2string.js b/‎src/api/middlewares/json2string.js ‎template/src/api/middlewares/json2string.js
diff --git a/‎src/api/middlewares/logger.js ‎template/src/api/middlewares/logger.js b/‎src/api/middlewares/logger.js ‎template/src/api/middlewares/logger.js
diff --git a/‎src/api/middlewares/string2json.js ‎template/src/api/middlewares/string2json.js b/‎src/api/middlewares/string2json.js ‎template/src/api/middlewares/string2json.js
diff --git a/‎src/api/routes/$$channel$$.js ‎template/src/api/routes/$$channel$$.js b/‎src/api/routes/$$channel$$.js ‎template/src/api/routes/$$channel$$.js
diff --git a/‎src/lib/config.js ‎template/src/lib/config.js b/‎src/lib/config.js ‎template/src/lib/config.js
@@ -1,3 +1,26 @@
-# {{ asyncapi.info().title() }}
+# Node.js template for the AsyncAPI Generator
 
-{{ asyncapi.info().description() | safe }}
+## Usage
+
+```
+ag asyncapi.yaml @asyncapi/nodejs-template -o output -p server=production
+```
+
+If you don't have the AsyncAPI Generator installed, you can install it like this:
+
+```
+npm install -g @asyncapi/generator
+```
+
+## Supported parameters
+
+|Name|Description|Required|Example|
+|---|---|---|---|
+|server|The server you want to use in the code.|Yes|`production`|
+
+## Supported protocols
+
+* AMQP
+* MQTT
+* Kafka
+* WebSockets
@@ -0,0 +1,3 @@
+# {{ asyncapi.info().title() }}
+
+{{ asyncapi.info().description() | safe }}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# {{ asyncapi.info().title() }}`
	`2`	`+`
	`3`	`+{{ asyncapi.info().description() \| safe }}`