From 064b4df0fbbaa4d55f781d149e6e5611f67e2dfa Mon Sep 17 00:00:00 2001 From: Rising Odegua Date: Tue, 1 Feb 2022 14:48:09 +0100 Subject: [PATCH 1/2] update cli app readme --- bin/README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/bin/README.md b/bin/README.md index be22023b..1006d71c 100644 --- a/bin/README.md +++ b/bin/README.md @@ -79,4 +79,20 @@ Why to deploy my data? * Can integrate access control (?) * Deploys a data API * [Other integrations e.g. push to google spreadsheets] -* Dashboard showing your DataHub/Portal projects \ No newline at end of file +* Dashboard showing your DataHub/Portal projects + +### Extra supported commands +You can directly specify a folder to build from: +```bash +portal show path=\some\path\dataset +``` + +Optional args you can pass yo the show command are: + +- path: The path to a dataset directory. If blank, defaults to current working directory +- port: The port number to display your dataset in. Defaults to 3000. +- npm: Whether or not to use npm when install packages. Defaults to `false`, uses yarn. + +``` +portal show [path=/some/path/dataset | port=4000 | npm=true] +``` \ No newline at end of file From 14b14f24e7672719fe96f7285345c5c912e5f1fa Mon Sep 17 00:00:00 2001 From: Rising Odegua Date: Wed, 2 Feb 2022 08:57:54 +0100 Subject: [PATCH 2/2] Update path sep in ReadMe --- bin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/README.md b/bin/README.md index 1006d71c..6f1fa39e 100644 --- a/bin/README.md +++ b/bin/README.md @@ -94,5 +94,5 @@ Optional args you can pass yo the show command are: - npm: Whether or not to use npm when install packages. Defaults to `false`, uses yarn. ``` -portal show [path=/some/path/dataset | port=4000 | npm=true] +portal show [path=\some\path\dataset | port=4000 | npm=true] ``` \ No newline at end of file