Skip to content

Commit bcbd709

Browse files
author
Jani Giannoudis
committed
updated README.md
1 parent 353daea commit bcbd709

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
<h1>Payroll Engine Client Services</h1>
22

33
Main library for Payroll Engine clients, including all required dependencies:
4-
- Function controllers (local scripting development)
4+
- Function controllers (local script development)
55
- Function invokers
66
- JSON schemas
77

8+
## HTML documentantion
9+
The client scripting library contains static HTML documentation for client developers. This is created using [docx](https://github.com/dotnet/docfx) [MIT]. The following commands are available in the `docfx` folder:
10+
- `Static.Build` - builds the static HTML content (output is the `_site` subdirectory)
11+
- `Static.Static` - opens the static help (`_site\index.html`)
12+
- `Server.Start` - start the static help on http://localhost:4037/ (dark mode support)
13+
814
## Build
915
Supported runtime environment variables:
10-
- *PayrollEnginePackageDir* - the NuGet package target direcotry (optional)
16+
- *PayrollEnginePackageDir* - the NuGet package destination directory (optional)

0 commit comments

Comments
 (0)