Skip to content

Commit 970b3e6

Browse files
author
Denis Gursky
authored
Updated config example (#93)
* update config example * added config.spec
1 parent 8613324 commit 970b3e6

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,20 @@ include the following:
3030
```conf
3131
[default]
3232
host = azure.relationalai.com
33-
port = <api-port> # optional, default: 443
34-
scheme = <scheme> # optional, default: https
3533
client_id = <your client_id>
3634
client_secret = <your client secret>
37-
client_credentials_url = <account login URL> # optional
38-
# default: https://login.relationalai.com/oauth/token
35+
36+
# the following are all optional, with default values shown
37+
# port = 443
38+
# scheme = https
39+
# client_credentials_url = https://login.relationalai.com/oauth/token
3940
```
4041

4142
Client credentials can be created using the RAI console at
4243
https://console.relationalai.com/login
4344

45+
You can copy `config.spec` from the root of this repo and modify as needed.
46+
4447
### Usage
4548

4649
The package provides `readConfig` helper that reads the configuration file

config.spec

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[default]
2+
host = azure.relationalai.com
3+
client_id = <your client_id>
4+
client_secret = <your client secret>
5+
6+
# the following are all optional, with default values shown
7+
# port = 443
8+
# scheme = https
9+
# client_credentials_url = https://login.relationalai.com/oauth/token

0 commit comments

Comments
 (0)