diff --git a/config-serializer/README.md b/config-serializer/README.md index dcb200e3..4f35bc7d 100644 --- a/config-serializer/README.md +++ b/config-serializer/README.md @@ -1,6 +1,6 @@ # Configuration serializer -This directory contains the configuration serializer of Agent. +This directory contains the configuration serializer of Agent. The configuration of the UHK is unusually complex for a keyboard, and is composed of a number of items of different types, including keymaps, layers, macros, and the like. This is a supposed to be a short guide for the aspiring hacker. Let's get right into it! @@ -8,7 +8,7 @@ The configuration of the UHK is unusually complex for a keyboard, and is compose 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 [uhk-config.json](uhk-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.