8000 Improve the README a bit · guyzmo/python-gitlab@f6abd4d · GitHub
[go: up one dir, main page]

Skip to content

Commit f6abd4d

Browse files
author
Gauvain Pocentek
committed
Improve the README a bit
Fix typos Detail which options are required in the [global] section (closes python-gitlab#61)
1 parent 1f48e65 commit f6abd4d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,21 +73,25 @@ Here's an example of the syntax:
7373

7474
`````
7575
[global]
76+
# required setting
7677
default = local
78+
79+
# optional settings
7780
ssl_verify = true
7881
timeout = 5
7982
8083
[local]
8184
url = http://10.0.3.2:8080
85+
# get the private token from the gitlab web interface
8286
private_token = vTbFeqJYCY3sibBP7BZM
8387
84-
[distant]
88+
[remote]
8589
url = https://some.whe.re
8690
private_token = thisisaprivatetoken
8791
ssl_verify = false
8892
`````
8993

90-
The [global] section define which server is accesed by default.
94+
The [global] section defines which server is accessed by default.
9195
Each other section defines how to access a server. Only private token
9296
authentication is supported (not user/password).
9397

@@ -100,7 +104,7 @@ server should be abandonned.
100104
Choosing a different server than the default one can be done at run time:
101105

102106
`````
103-
gitlab --gitlab=distant [command]
107+
gitlab --gitlab=remote [command]
104108
`````
105109

106110
gitlab always requires 2 mandatory arguments.

0 commit comments

Comments
 (0)
0