From f417525195fab2d7f479f155d827c1e0c30de57f Mon Sep 17 00:00:00 2001 From: Roman Klopsch Date: Wed, 17 Apr 2019 08:56:24 +0000 Subject: [PATCH] docs: Update README.md --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6ef85388..ff459ff3 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,29 @@ Example to copy all Events of the b-tu instance: ```shell npm install npm run build -node ./lib/cli.js copy -t Event --appVersion 1.0.0 https://stappsbe01.innocampus.tu-berlin.de http://localhost:3000 +node ./lib/cli.js copy Event https://stappsbe01.innocampus.tu-berlin.de http://localhost:3000 100 ``` ### Program arguments: ```shell -node ./lib/cli.js copy --appVersion -t +node ./lib/cli.js copy ``` -Example execution with docker when backend is running on `localhost:3000`: +#### Options: +```shell +-s, --bulkSource +``` +The source identifier for the bulk to use with the target instance (default is 'copy') ```shell -docker run --net=host registry.gitlab.com/openstapps/api/copy copy -t Place --appVersion 1.0.0 https://stappsbe01.innocampus.tu-berlin.de http://localhost:3000 +-a, --appVersion +``` +The App version to use (unset by default) + +### Example execution +with docker when backend is running on `localhost:3000`: + +```shell +docker run --net=host registry.gitlab.com/openstapps/api/copy copy Place https://stappsbe01.innocampus.tu-berlin.de http://localhost:3000 100 ```