Commitf6abd4d

Gauvain Pocentek

committed

Improve the README a bit

Fix typosDetail which options are required in the [global] section (closes#61)

1 parent1f48e65 commitf6abd4dCopy full SHA for f6abd4d

File tree

-3

lines changed

-3

lines changed

Lines changed: 7 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -73,21 +73,25 @@ Here's an example of the syntax:`
`73`	`73`
`74`	`74`	`````
`75`	`75`	`[global]`
	`76`	`+# required setting`
`76`	`77`	`default = local`
	`78`	`+`
	`79`	`+# optional settings`
`77`	`80`	`ssl_verify = true`
`78`	`81`	`timeout = 5`
`79`	`82`
`80`	`83`	`[local]`
`81`	`84`	`url = http://10.0.3.2:8080`
	`85`	`+# get the private token from the gitlab web interface`
`82`	`86`	`private_token = vTbFeqJYCY3sibBP7BZM`
`83`	`87`
`84`		`-[distant]`
	`88`	`+[remote]`
`85`	`89`	`url = https://some.whe.re`
`86`	`90`	`private_token = thisisaprivatetoken`
`87`	`91`	`ssl_verify = false`
`88`	`92`	`````
`89`	`93`
`90`		`-The[global] sectiondefine which server isaccesed by default.`
	`94`	`+The[global] sectiondefines which server isaccessed by default.`
`91`	`95`	`Each other section defines how to access a server. Only private token`
`92`	`96`	`authentication is supported (not user/password).`
`93`	`97`
`@@ -100,7 +104,7 @@ server should be abandonned.`
`100`	`104`	`Choosing a different server than the default one can be done at run time:`
`101`	`105`
`102`	`106`	`````
`103`		`-gitlab --gitlab=distant [command]`
	`107`	`+gitlab --gitlab=remote [command]`
`104`	`108`	`````
`105`	`109`
`106`	`110`	`gitlab always requires 2 mandatory arguments.`

Comments

(0)