Skip to content

Commit dfb6f16

Browse files
committed
Improve documentation
1 parent 1d58eca commit dfb6f16

17 files changed

+5164
-1244
lines changed

docs/0-usage.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Usage
22

3+
You can use A11yJSON in any project that supports nested, JSON-like data structures or classes.
4+
5+
Best support is available for:
6+
7+
TypeScript, Node.js, Browsers (CommonJS/ES modules).
8+
9+
Usage is, of course, not limited to these environments – we encourage you to use the same structures
10+
in your Python, Rust, Java, Swift, PHP, … project!
11+
12+
Feel free to contribute automatically type generation for your favorite programming environment
13+
and [create an issue](https://github.com/sozialhelden/a11yjson/issues/new) if you plan to do this.
14+
315
## Installing the npm module
416

517
```bash
@@ -8,7 +20,7 @@ npm install --save @sozialhelden/a11yjson
820

921
## Basics
1022

11-
A11yJSON's reference provides a documentation of [all available interfaces](./describing-objects/interfaces.md) and has [example A11yJSON objects](./1-example-data.md).
23+
A11yJSON's reference provides a documentation of [the A11yJSON data model](./describing-objects/0-model.md) and has [example A11yJSON objects](example-data/index.md).
1224

1325
For each interface `X` you find in the reference, the `a11yjson` npm module provides
1426

@@ -37,14 +49,12 @@ const placeInfo: PlaceInfo = {
3749
watch: {
3850
perception: {
3951
languages: ['fr'],
40-
dedicatedScreenForSubtitles: true,
41-
subtitles: true,
42-
audioDescription: true,
43-
byod: true,
52+
subtitles: "always",
53+
audioDescription: "sometimes",
54+
byod: "optional",
4455
educationLevel: 3,
45-
visual: true,
46-
realTimeCaptioning: true,
47-
signLanguage: true,
56+
visual: "optional",
57+
signLanguage: "optional",
4858
}
4959
}
5060
}

docs/1-example-data.md

-176
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)