Skip to content

Commit fada882

Browse files
committed
Add a README to the skeleton project
1 parent f8068ca commit fada882

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ _output/go/bin/go-bindata:
77

88
ofcourse/bindata.go: _output/go/bin/go-bindata templates/resource/resource.go \
99
templates/resource/resource_test.go templates/Dockerfile templates/Makefile \
10-
templates/pipeline.yml templates/go.mod templates/cmd/check/main.go \
11-
templates/cmd/out/main.go templates/cmd/in/main.go
10+
templates/README.md templates/pipeline.yml templates/go.mod \
11+
templates/cmd/check/main.go templates/cmd/out/main.go templates/cmd/in/main.go
1212
./_output/go/bin/go-bindata \
1313
-o ofcourse/bindata.go \
1414
-pkg ofcourse \

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,10 @@ For the `docker` and `publish` targets, if `VERSION` is passed to `make`, then t
107107
> make publish VERSION=1.2.3
108108
```
109109

110+
# Project README
111+
112+
A skeleton `README.md` file is generated for the project, which should be filled in with valid descriptions, and should document the source config and parameters required to make the resource function properly. The format follows the ones used by builtin Concourse resources, for example the [git resource](https://github.com/concourse/git-resource) or the [s3 resource](https://github.com/concourse/s3-resource).
113+
110114
# Logging
111115

112116
Since Concourse resources communicate back to Concourse over standard output, they cannot print information to standard output. For this reason, each of the `Check`, `In`, and `Out` methods receive a `logger` argument that will print to standard error, using colored log levels. The log level may be configured in the `source` of every resource that uses the `ofcourse` library. The available levels are `debug`, `info`, `warn`, `error`, and `silent`.

ofcourse/bindata.go

+23
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)