Bart\Jenkins\JenkinsConfig::README PHP Method

README() public method

public README ( ) : string
return string Sample of how configuration is intended to be defined
    public function README()
    {
        return <<<README
; domain and location are the only required fields
[api]
domain = 'jenkins.example.com'
; Defaults to 'http'
protocol = 'http'
; Defaults to 8080
port = 8080
; user & token default to null for anonymous connections
user = 'example-user'
token = 'example-token'
[job]
; location specifies the location of the Jenkins job, e.g. if your job is defined in the
; third level project: Base->Build->Example, the location is specified as below.
location = 'job/Base/job/Build/job/Example'

README;
    }