Skip to content

Commit 3d3deae

Browse files
authored
Check error and update readme (#4)
1 parent b47f972 commit 3d3deae

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# taubyte/go-simple-container
2+
3+
[![GoDoc](https://godoc.org/github.com/taubyte/go-simple-container?status.svg)](https://pkg.go.dev/github.com/taubyte/go-simple-container)
4+
[![Go Report Card](https://goreportcard.com/badge/taubyte/go-simple-container)](https://goreportcard.com/report/taubyte/go-simple-container)
5+
26
An abstraction layer over the docker api client. Goal: make it simple to use containers from go.
37

48
## Installation
@@ -10,7 +14,7 @@ go get github.com/taubyte/go-simple-container
1014
```
1115

1216

13-
# Usage
17+
## Usage
1418

1519
### Basic Example
1620
```go
@@ -140,19 +144,15 @@ Then run
140144
$ go test -v
141145
```
142146

143-
# Help
147+
## Help
144148
Find us on our [Discord](https://discord.gg/eKfazxFDf9)
145149

146-
# API documentation
147-
[https://pkg.go.dev/github.com/taubyte/go-simple-git](https://pkg.go.dev/github.com/taubyte/go-simple-git)
148-
149-
# License
150+
## License
150151
The package is licensed under the GPL v3 licenses.
151-
Please see the LICENSE file for details.
152152

153-
# Maintainers
153+
See [LICENSE](LICENSE) for the full license text.
154+
155+
## Maintainers
154156
- Samy Fodil @samyfodil
155157
- Tafseer Khan @tafseer-khan
156-
157-
158-
158+
- Samuel Stoltenberg @skelouse

tests/all_test.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ func TestContainerCleanUpInterval(t *testing.T) {
8181
}
8282

8383
err = gc.Start(ctx, gc.Interval(20*time.Second), gc.MaxAge(10*time.Second))
84+
if err != nil {
85+
t.Error(err)
86+
return
87+
}
8488

8589
file, err := os.OpenFile(DockerTarBallPath, os.O_RDWR, 0444)
8690
if err != nil {

0 commit comments

Comments
 (0)