aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorValentin Popov <info@valentineus.link>2017-10-05 00:52:35 +0300
committerValentin Popov <info@valentineus.link>2017-10-05 00:52:35 +0300
commit15f294f270b2f0b65a83c16f1f25738b9b03fdc8 (patch)
tree0f763d32c1076e66a2ae706152b84a6872ef494c /README.md
parentb36916c7f540d55ae28962503d4d1135e3ce3092 (diff)
downloadsimple-container-15f294f270b2f0b65a83c16f1f25738b9b03fdc8.tar.xz
simple-container-15f294f270b2f0b65a83c16f1f25738b9b03fdc8.zip
Realization of the basic functionality of creating the container
Diffstat (limited to 'README.md')
-rw-r--r--README.md77
1 files changed, 73 insertions, 4 deletions
diff --git a/README.md b/README.md
index a901a5e..38eeab9 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
[![Codacy Coverage Badge](https://api.codacy.com/project/badge/Coverage/286921416577421c98e5f77ce400926c)](https://www.codacy.com/app/valentineus/simple-container/files)
[![Gitter Badge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valentineus/simple-container)
-Simple and fast work with the Docker container
+Simple and fast work with the Docker container.
## Installation
```bash
@@ -13,16 +13,85 @@ npm install --save simple-container
```
## Using
+A simple example:
```JavaScript
import Container from 'simple-container';
-var container = new Container({});
-container.create();
+var container = new Container();
+
+/* Create the container */
+container.create('postgres:alpine');
+
+/* Start the container */
+container.start();
+
+/* Stop and destroy the container */
+container.destroy();
+```
+
+### Remote connection
+By default, the local service is used.
+
+For example, if you want to use connection settings:
+```JavaScript
+var container = new Container({
+ host: '127.0.0.1',
+ port: 3000
+});
+```
+
+Examples and details in
+[the documentation](https://github.com/apocas/dockerode#getting-started).
+
+### Creating a container
+You can create a container in two ways.
+
+A simple way - to specify the name of the image:
+```JavaScript
+container.create('hello-world:latest');
+```
+
+Another way - to provide an object with parameters:
+```JavaScript
+container.create({
+ Image: 'postgres:alpine',
+ Env: ['POSTGRES_PASSWORD = password'],
+ Ports: [{
+ IP: '0.0.0.0',
+ PrivatePort: 5432,
+ PublicPort: 5432,
+ Type: 'tcp'
+ }]
+});
```
+Examples and details in
+[the documentation](https://github.com/apocas/dockerode#manipulating-a-container).
+
+An additional example of obtaining a private image:
+```JavaScript
+var auth = {
+ username: 'username',
+ password: 'password',
+ email: 'email@example.org',
+ serveraddress: 'https://index.docker.io/v1'
+};
+
+container.create({
+ Image: 'project:latest',
+ authconfig: auth
+});
+```
+
+Details in
+[the documentation](https://github.com/apocas/dockerode#pull-from-private-repos).
+
+## Debugging
+Use the `DEBUG` variable with the `container` option.
+
## License
[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/eslint/eslint)
[MIT](LICENSE.md).
Copyright (c)
-[Valentin Popov](https://valentineus.link/). \ No newline at end of file
+[Valentin Popov](mailto:info@valentineus.link). \ No newline at end of file