Skip to content

Commit 1a27c5a

Browse files
authored
Format settings as tables (#203)
1 parent 1e95df6 commit 1a27c5a

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,26 @@ An example of one topic with one subscriber is shown below.
3636

3737
### Topic Settings
3838

39-
- `name`: The name of the topic. It can only contain letters, numbers, and dashes.
40-
- `port`: The port to use for the topic endpoint. The topic will listen on `https://0.0.0.0:{port}/`.
41-
- `key`: The key that will be used to validate the `aeg-sas-key` or `aeg-sas-token` header in each request. If this is not supplied then no key validation will take place.
42-
- `subscribers`: The subscriptions for this topic.
39+
| Setting | Description |
40+
|---------|-------------|
41+
| `name` | The name of the topic. It can only contain letters, numbers, and dashes. |
42+
| `port` | The port to use for the topic endpoint. The topic will listen on `https://0.0.0.0:{port}/`. |
43+
| `key` | The key that will be used to validate the `aeg-sas-key` or `aeg-sas-token` header in each request. If this is not supplied then no key validation will take place. |
44+
| `subscribers` | The subscriptions for this topic. |
4345

4446
### Subscriber Settings
4547

46-
- `name`: The name of the subscriber. It can only contain letters, numbers, and dashes.
47-
- `endpoint`: The subscription endpoint url. Events received by topic will be sent to this address.
48-
- `disableValidation`:
49-
- `false` (the default) subscription validation will be attempted each time the simulator starts.
50-
- `true` to disable subscription validation.
48+
| Setting | Description |
49+
|---------|-------------|
50+
| `name` | The name of the subscriber. It can only contain letters, numbers, and dashes. |
51+
| `endpoint` | The subscription endpoint url. Events received by topic will be sent to this address. |
52+
| `disableValidation` | Set to `true` to disable subscription validation. Default is `false`, which means subscription validation will be attempted each time the simulator starts. |
5153

5254
### App Settings
5355

54-
- `dangerousAcceptAnyServerCertificateValidator`: Set to `true` to accept any server certificate. This is useful when testing with self signed certificates.
56+
| Setting | Description |
57+
|---------|-------------|
58+
| `dangerousAcceptAnyServerCertificateValidator` | Set to `true` to accept any server certificate. Useful when testing with self-signed certificates. |
5559

5660
#### Subscription Validation
5761

0 commit comments

Comments
 (0)