diff --git a/README.md b/README.md index 0baa4b976..bd083b5e6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Java Spring template for the [AsyncAPI Generator](https://github.com/asyncapi/ge --- [![License](https://img.shields.io/github/license/asyncapi/java-spring-template)](https://github.com/asyncapi/java-spring-template/blob/master/LICENSE) -![npm](https://img.shields.io/npm/v/@asyncapi/java-spring-template?style=flat-square) +[![npm](https://img.shields.io/npm/v/@asyncapi/java-spring-template?style=flat-square)](https://www.npmjs.com/package/@asyncapi/java-spring-template) [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-) ![downloads](https://img.shields.io/npm/dm/@asyncapi/java-spring-template?style=flat-square) --- @@ -13,6 +13,14 @@ Java Spring template for the [AsyncAPI Generator](https://github.com/asyncapi/ge +- [Usage](#usage) + * [AsyncAPI definitions](#asyncapi-definitions) + * [Supported parameters](#supported-parameters) + * [Examples](#examples) +- [Run it](#run-it) +- [Development](#development) + * [Missing features](#missing-features) +- [Contributors ✨](#contributors-%E2%9C%A8) @@ -55,7 +63,7 @@ It is RECOMMENDED to not use anonymous objects in payload and components definit ``` - Complete example for MQTT is [here](tests/mocks/mqtt.yml). -#### Supported parameters +### Supported parameters |Name|Description| Required | Default | |---|---|----------|--------------------------| @@ -72,7 +80,7 @@ It is RECOMMENDED to not use anonymous objects in payload and components definit |completionTimeout|Only for MQTT. The completion timeout in milliseconds for operations. The default completion timeout is 30000 milliseconds.| No | `30000` | |mqttClientId| Only for MQTT. Provides the client identifier for the MQTT server. This parameter overrides the value of the clientId if it's set in the AsyncAPI file.If both aren't provided, a default value is set.| No | | |asyncapiFileDir| Path where original AsyncAPI file will be stored.| No | `src/main/resources/api/` | -#### Examples +### Examples The shortest possible syntax: ```bash @@ -147,13 +155,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d - + - - -

Semen
🚧📖 💻🐛👀⚠️
Semen
📖 💻
Francesco Nobilia
👀
Lukasz Gornicki
👀
Amrut Prabhu
💻
Vaishnavi Nandakumar
💻
taotao100
🐛 -
Jacopo Biscella
🐛
diff --git a/package.json b/package.json index 207e05b28..b34ebb2bb 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,8 @@ "scripts": { "test": "rimraf test/temp && jest --modulePathIgnorePatterns='./template'", "lint": "echo \"No linter specified yet\"", - "generate:assets": "echo 'No additional assets need to be generated at the moment'", + "generate:readme:toc": "markdown-toc -i README.md", + "generate:assets": "npm run generate:readme:toc", "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION" }, "publishConfig": { @@ -40,7 +41,8 @@ "@asyncapi/generator": "^1.14.0", "jest": "^29.6.4", "node-fetch": "^2.6.1", - "rimraf": "^2.2.8" + "rimraf": "^2.2.8", + "markdown-toc": "^1.2.0" }, "generator": { "supportedProtocols": [