Skip to content

Commit 56a8d7f

Browse files
committed
added godoc reference badge
1 parent 3b92e49 commit 56a8d7f

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# go-microkit-plugins
22

3+
[![](https://godoc.org/github.com/chryscloud/go-microkit-plugins?status.svg)](https://godoc.org/github.com/chryscloud/go-microkit-plugins)
4+
35
## Introduction
46

57
Microkit Plugins is a set of backend GO libraries unifying development across multiple distributed microservices. It contains set of best practices and simple reusable modules most commonly used with RESTful microservices.
@@ -558,26 +560,26 @@ cl := docker.NewSocketClient(docker.Log(g.Log), docker.Host("unix:///var/run/doc
558560
Available docker methods:
559561
```go
560562
ContainersList() ([]types.Container, error)
561-
ContainersListWithOptions(opts types.ContainerListOptions) ([]types.Container, error)
562-
ContainerLogs(containerID string, tailNumberLines int, sinceTimestamp time.Time) (*models.DockerLogs, error)
563-
564-
// ContainerLogsStream streams logs to output channel until done is received. User is responsible to close the passed in channel
565-
ContainerLogsStream(containerID string, output chan []byte, done chan bool) error
566-
567-
// Container CRUD operations
568-
ContainerCreate(name string, config *container.Config, hostConfig *container.HostConfig, networkConfig *network.NetworkingConfig) (*container.ContainerCreateCreatedBody, error)
569-
ContainerStart(containerID string) error
570-
ContainerRestart(containerID string, waitForRestartLimit time.Duration) error
571-
ContainersPrune(pruneFilter filters.Args) (*types.ContainersPruneReport, error)
572-
ContainerStop(containerID string, killAfterTimeout *time.Duration) error
573-
ContainerGet(containerID string) (*types.ContainerJSON, error)
574-
ContainerStats(containerID string) (*types.StatsJSON, error)
575-
ImagesList() ([]types.ImageSummary, error)
576-
ImagePullDockerHub(image, tag string, username, password string) (string, error)
577-
ImageRemove(imageID string) ([]types.ImageDelete, error)
578-
VolumesPrune(pruneFilter filters.Args) (*types.VolumesPruneReport, error)
579-
GetDockerClient() *client.Client
580-
CalculateStats(jsonStats *types.StatsJSON) *models.Stats
563+
ContainersListWithOptions(opts types.ContainerListOptions) ([]types.Container, error)
564+
ContainerLogs(containerID string, tailNumberLines int, sinceTimestamp time.Time) (*models.DockerLogs, error)
565+
566+
// ContainerLogsStream streams logs to output channel until done is received. User is responsible to close the passed in channel
567+
ContainerLogsStream(containerID string, output chan []byte, done chan bool) error
568+
569+
// Container CRUD operations
570+
ContainerCreate(name string, config *container.Config, hostConfig *container.HostConfig, networkConfig *network.NetworkingConfig) (*container.ContainerCreateCreatedBody, error)
571+
ContainerStart(containerID string) error
572+
ContainerRestart(containerID string, waitForRestartLimit time.Duration) error
573+
ContainersPrune(pruneFilter filters.Args) (*types.ContainersPruneReport, error)
574+
ContainerStop(containerID string, killAfterTimeout *time.Duration) error
575+
ContainerGet(containerID string) (*types.ContainerJSON, error)
576+
ContainerStats(containerID string) (*types.StatsJSON, error)
577+
ImagesList() ([]types.ImageSummary, error)
578+
ImagePullDockerHub(image, tag string, username, password string) (string, error)
579+
ImageRemove(imageID string) ([]types.ImageDelete, error)
580+
VolumesPrune(pruneFilter filters.Args) (*types.VolumesPruneReport, error)
581+
GetDockerClient() *client.Client
582+
CalculateStats(jsonStats *types.StatsJSON) *models.Stats
581583
```
582584

583585
# Contributing

0 commit comments

Comments
 (0)