From 1cdac9f60dcef0e0d95e18bd5b38c4348036c364 Mon Sep 17 00:00:00 2001 From: Rainer Killinger Date: Tue, 7 Sep 2021 13:12:26 +0200 Subject: [PATCH] docs: update README.md --- README.md | 8 ++++++-- src/cli.ts | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e8fea77..cc50e3cd 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,15 @@ npm run build To start the plugin, you need to execute the code in "CLI" script: ```shell script -node lib/cli.js run +node lib/cli.js -b -n -r -u -p + With fallback values being: -node lib/cli.js run http://localhost:3000 minimal-plugin minimalPlugin http://localhost 4000 +backendURL = http://localhost:3000 , pluginName = minimal-plugin , +routeName = minimalplugin , URL = http://localhost, port = 4000 ``` +Using environment variables you can set backendURL via `STAPPS_BACKEND`, URL via `PLUGIN_URL` and port via `PLUGIN_URL`. + ## Creating your own plugin * Modify the default values in `cli.ts` to your needs: diff --git a/src/cli.ts b/src/cli.ts index bf60f0e0..a19ec916 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -72,7 +72,7 @@ const plugin = new MinimalPlugin( pluginClient.registerPlugin(plugin) .then(() => { - Logger.ok(`Successfully registered plugin '${options.pluginName}' on /${options.urlSegment} .`); + Logger.ok(`Successfully registered plugin '${options.pluginName}' on /${options.routeName} .`); }) .catch((err: Error) => { throw err;