uhk/agent
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: fix renamed uhk-config.json to user-config (#289)

Browse Source
This commit is contained in:
Attila Csanyi
2017-04-28 22:50:40 +02:00
committed by László Monda
parent a48b99ea05
commit c57e52fc45
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
shared/src/config-serializer/README.md
View File

@@ -12,7 +12,7 @@ Given that the development dependencies are installed on your system you should
There are 3 different representations of the configuration, each filling a specific purpose.
The **JavaScript representation** is optimally suited to be serialized as JSON, and saved to the file system, or transmitted over the network. As a plaintext format, it's human-readable and easily editable. See [uhk-config.json](uhk-config.json) for an example configuration.
The **JavaScript representation** is optimally suited to be serialized as JSON, and saved to the file system, or transmitted over the network. As a plaintext format, it's human-readable and easily editable. See [user-config.json](user-config.json) for an example configuration.
The **TypeScript representation** is structurally similar to the JavaScript representation, but it features strongly typed TypeScript objects instead of typeless JavaScript objects. This representation is meant to be used by Agent. Extensive, per-property [assertion](assert.ts) takes place upon initializing the TypeScript objects to ensure the integrity of the configuration.