		{
		"name": "action-docs",
		"version": "0.0.21-beta",
		"version": "0.1.0-beta.1",
		"description": "Generate GitHub action docs based on action.yml",
		"main": "lib/index.js",
		"types": "lib/index.d.ts",
		"main": "dist/index.js",
		"types": "dist/index.d.ts",
		"bin": {
		"action-docs": "lib/cli.js"
		"action-docs": "dist/cli.js"
		},
		@@ -16,3 +16,3 @@ "scripts": {
		"test": "jest --coverage",
		"all": "npm run build && npm run format && npm run lint && npm run package && npm test",
		"all": "npm run build && npm run format && npm run lint && npm test",
		"watch": "ts-node-dev --respawn --exit-child",
		@@ -75,6 +75,3 @@ "dev": "ts-node",
		},
		"homepage": "https://github.com/npalm/action-docs#readme",
		"directories": {
		"lib": "lib"
		}
		}
		"homepage": "https://github.com/npalm/action-docs#readme"
		}

README.md

		@@ -7,2 +7,4 @@ # Action docs

		Generate docs via cli.

		```bash
		@@ -19,2 +21,18 @@ npm install -g action-docs

		Update your README.md

		```
		## Add the following comment blocks to your README.md
		<!-- terraform-docs-description -->

		<!-- terraform-docs-inputs -->

		<!-- terraform-docs-outputs -->

		<!-- terraform-docs-runs -->

		## Run the cli
		action-docs -u
		```

		## CLI
		@@ -37,2 +55,20 @@


		### Update the README.

		Action-docs can update your README based on the `action.yml`. The following sections can be updated: description, inputs, outputs and runs. Add the following tags to your README and run `actiond-docs -u`.

		```
		<!-- terraform-docs-description -->

		<!-- terraform-docs-inputs -->

		<!-- terraform-docs-outputs -->

		<!-- terraform-docs-runs -->
		```

		For updating other Markdown files add the name of the file to the command `action-docs -u <file>`.


		### Examples
		@@ -66,2 +102,4 @@



		## API
		@@ -78,2 +116,11 @@
		});
		```
		```

		## Contribution

		We welcome contribution, please checkout the [contribution guide](CONTRIBUTING.md).


		## License

		This project are released under the [MIT License](./LICENSE).

action-docs - npm Package Compare versions

Improved metrics