Skip to content

Commit 7b97fe3

Browse files
authored
Update README.md
1 parent fbe01de commit 7b97fe3

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ vRODoc is a PowerShell-based tool that automatically generates comprehensive JSD
4141
### Parameters
4242
| Parameter | Description | Default |
4343
|-------------|--------------------------------------------------|----------------|
44-
| vroHost | embedded vRO server FQDN | vro.domain |
44+
| vroHost | vRA FQDN for embedded vRO | vro.domain |
4545
| vroPort | vRO port (443 for 8.x, 8281 for 7.x) | 443 |
4646
| user | Username for vRA authentication | user@domain |
47-
| pass | Password for vRA authentication | - |
47+
| pass | Password for vRA authentication | pa$$W0rd |
4848
| exportPath | Output directory for documentation | C:\Users\user\ |
4949
| packageName | vRO package name to document | - |
5050
| autoFix | Automatically fix missing prerequisites | true |
@@ -65,6 +65,12 @@ exportPath/
6565

6666
![vrodoc_2](https://github.com/user-attachments/assets/bf034c86-01eb-4aef-a1a4-e9cb70bce10f)
6767

68+
## Steps to follow
69+
- Create a package with all the custom actions.
70+
- As script works for embedded vRO, fill all the parameter values either in script or while running the script.
71+
- In the export path, you will find a directory called "vRODoc Files"
72+
- Open vRODoc Files > packageName folder > docs > index.html
73+
- In your browser, a page will open up with all your actions in a beautiful JSdoc format.
6874

6975
## Features
7076
- Automatic prerequisite validation

0 commit comments

Comments
 (0)