add community samples structure

community-samples/readme.md

@@ -0,0 +1,22 @@
+# Community Samples
+
+This file refers to the community samples for the usage of this module in CI/CD environments like GitLab CI, Jenkins, Azure DevOps and so on.
+
+If you want to contribute your use case, please see [#44][i44] for further details.
+
+## CI/CD environments
+
+### Azure DevOps
+-
+
+### CircleCI
+-
+
+### GitLab CI
+-
+
+### Jenkins
+-
+
+
+[i44]: https://github.com/PDMLab/docker-compose/issues/44

readme.md

@@ -2,6 +2,12 @@
 
 `docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/)(which is still required) via Node.js. This is useful to bootstrap test environments. You might also generate your `docker-compose.yml` files using [composefile](https://www.npmjs.com/package/composefile).
 
+## Existing user? We need your help
+First of all: thanks for using the `docker-compose` module.
+As described in [#44][i44], we're planning to provide more guidance for CI/CD when using the `docker-compose` module and it would be great if you could support us here. More details in [#44][i44].
+
+[i44]: https://github.com/PDMLab/docker-compose/issues/44
+
 ## Installation
 
 ```
@@ -33,7 +39,7 @@ npm install --save-dev docker-compose
 All commands return a `Promise({object})` with an stdout and stderr strings
 ```javascript
 {
-  out: 'stdout contents' 
+  out: 'stdout contents'
   err: 'stderr contents'
 }
 ```
@@ -45,7 +51,7 @@ To start service containers based on the `docker-compose.yml` file in your curre
 ```javascript
 compose.upAll({ cwd: path.join(__dirname), log: true })
   .then(
-    () => { console.log('done')}, 
+    () => { console.log('done')},
     err => { console.log('something went wrong:', err.message)}
   );
 ```