From 6de3abe3bfc3ac2fed254bd3d6120f6bee5bdfce Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Wed, 20 Nov 2019 13:36:36 +0000 Subject: [PATCH] fix(readme): update --- readme.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..1827961 --- /dev/null +++ b/readme.md @@ -0,0 +1,43 @@ +# @mojoio/docker +unofficial docker engine api abstraction package written in TypeScript + +## Availabililty and Links +* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker) +* [gitlab.com (source)](https://gitlab.com/mojoio/docker) +* [github.com (source mirror)](https://github.com/mojoio/docker) +* [docs (typedoc)](https://mojoio.gitlab.io/docker/) + +## Status for master +[![build status](https://gitlab.com/mojoio/docker/badges/master/build.svg)](https://gitlab.com/mojoio/docker/commits/master) +[![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://gitlab.com/mojoio/docker/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker) +[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker) +[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) +[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) +[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) + +## Usage + +Use TypeScript for best in class instellisense. + +```typescript +import { DockerHost } from '@mojoio/docker'; // require Dockersock class + +const run = async () => { + const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to /var/run/docker.sock + + const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers +}; +``` + + +## Contribution + +We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) + +For further information read the linked docs at the top of this readme. + +> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) + +[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)