📚 docs: add missing stage param for sls in read me file

Author: Guy7B

README.md

@@ -10,7 +10,7 @@
   </a>
 </p>
 
-  
+
 
 Dynamo Data Transform is an easy to use data transformation tool for DynamoDB.
 
@@ -85,7 +85,7 @@ dynamodt -i
 1. Intialize data-transformations folder
 Serverless (the plugin reads the table names from the serverless.yml file):
 ```bash
-sls dynamodt init
+sls dynamodt init --stage <stage>
 ```
 Standalone:
 ```bash

examples/serverless-localstack/README.md

@@ -1,4 +1,4 @@
-# This repository shows the usage of the dynamo-data-transform package.
+## This repository shows the usage of the dynamo-data-transform package.
 
 ## Quick Start
 
@@ -69,7 +69,7 @@ history - `ddt history -t Users`
     ```
     Now lets prepare some data for the transformation. Run the same command as before but without --dry.
     ```bash
-    npx sls dynamodt prepare --table UsersExample --tNumber 4
+    npx sls dynamodt prepare --table UsersExample --tNumber 4  --stage local
     ```
     Let's run the pending transformation script, currently it is "v4_using_preparation_data.js"
     ```bash

examples/serverless-localstack/index.js

@@ -2,19 +2,18 @@
   "name": "dynamo-db-data-transformation-example",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
   "scripts": {
     "start": "serverless deploy -s local",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "dynamo-data-transform": "^0.1.2",
+    "dynamo-data-transform": "^0.1.5",
     "serverless": "^3.17.0",
     "serverless-dotenv-plugin": "~3.9.0",
     "serverless-localstack": "~0.4.35",
     "serverless-manifest-plugin": "~1.0.7",
     "serverless-pseudo-parameters": "~2.5.0"
   },
-  "author": "Guy Braunstain <[email protected]>",
+  "author": "Guy Braunstain <guy.braunstain@jit.io>",
   "license": "MIT"
 }

examples/serverless-localstack/package.json

@@ -28,18 +28,18 @@ module.exports = {
     usage: 'Run data transformations',
     commands: {
       init: {
-        usage: `sls dynamodt init - ${COMMAND_DESCRIPTION.init}`,
+        usage: `sls dynamodt init --stage <stage> - ${COMMAND_DESCRIPTION.init}`,
         lifecycleEvents: ['init'],
       },
       up: {
-        usage: `sls dynamodt up - ${COMMAND_DESCRIPTION.up}`,
+        usage: `sls dynamodt up --stage <stage> - ${COMMAND_DESCRIPTION.up}`,
         lifecycleEvents: ['transform'],
         options: {
           dry: COMMAND_OPTIONS.dry,
         },
       },
       prepare: {
-        usage: `"sls dynamodt prepare --table <table> --tNumber <transformation_number>" - ${COMMAND_DESCRIPTION.prepare}`,
+        usage: `"sls dynamodt prepare --table <table> --tNumber <transformation_number> --stage <stage>" - ${COMMAND_DESCRIPTION.prepare}`,
         lifecycleEvents: ['prepare'],
         options: {
           tNumber: COMMAND_OPTIONS.tNumber,
@@ -48,15 +48,15 @@ module.exports = {
         },
       },
       down: {
-        usage: `sls dynamodt down --table <table> - ${COMMAND_DESCRIPTION.down}`,
+        usage: `sls dynamodt down --table <table> --stage <stage> - ${COMMAND_DESCRIPTION.down}`,
         lifecycleEvents: ['rollback'],
         options: {
           table: COMMAND_OPTIONS.table,
           dry: COMMAND_OPTIONS.dry,
         },
       },
       history: {
-        usage: `sls dynamodt history --table <table> -  ${COMMAND_DESCRIPTION.history}`,
+        usage: `sls dynamodt history --table <table> --stage <stage> -  ${COMMAND_DESCRIPTION.history}`,
         lifecycleEvents: ['history'],
         options: {
           table: COMMAND_OPTIONS.table,

serverless-plugin/commands.js

@@ -3,7 +3,7 @@ const { DATA_TRANSFORMATIONS_FOLDER_NAME } = require('../config/constants');
 
 const createFolderIfNotExist = (folderPath) => {
   if (!fs.existsSync(folderPath)) {
-    console.info(`${folderPath} folder does not exist, creating it`);
+    console.info(`${folderPath} folder does not exist, creating...`);
     fs.mkdirSync(folderPath);
     return false;
   }