Skip to content

Commit 2eba914

Browse files
Small improvements in README
1 parent a804f20 commit 2eba914

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ docker run -v $(pwd)/config.toml:/app/config.toml -p 4567:4567 --rm -it gustavka
5555

5656
To get started you only need to configure the URI of your JIRA server and some user credentials (unless anonymous access is allowed). There are two ways to configure the application:
5757

58-
### Config file
58+
### Configuration file
5959

60-
Create a configuration file with the `.toml` extension and set it up like this:
60+
Create a file with the `.toml` extension and set it up like this:
6161

6262
```toml
6363
[jira]
@@ -68,18 +68,28 @@ password = "somepassword"
6868

6969
### Environment variables
7070

71-
Set environment variables for the configuration options according to the following pattern: `<section>_<key>=<value>`. Compare this example with the above config file example to see the similarity:
71+
Environment variables should follow the pattern: `<section>_<key>`. Compare these examples with the above config file example to see the similarity:
72+
73+
#### Configuring environment variables on Linux/OS X
7274

7375
```shell
74-
jira_uri=https://jira.mycompany.com
75-
jira_username=someuser
76-
jira_password=somepassword
76+
export jira_uri="https://jira.mycompany.com"
77+
export jira_username="someuser"
78+
export jira_password="somepassword"
7779
```
7880

79-
For lists of values, use a comma as a separator:
81+
#### Configuring environment variables on Windows
8082

8183
```shell
82-
message_default_fields=assignee,status,reporter,priority
84+
setx jira_uri "https://jira.mycompany.com"
85+
setx jira_username "someuser"
86+
setx jira_password "somepassword"
87+
```
88+
89+
For lists of values, use a comma as a separator:
90+
91+
```text
92+
assignee,status,reporter,priority
8393
```
8494

8595
### Reference

0 commit comments

Comments
 (0)