Merge pull request #398 from snehaljha-sf/read_me_update

chore:update readme

Author: snehaljha-sf

LICENSE.txt

@@ -1,6 +1,8 @@
 Copyright (c) 2018, Salesforce.com, Inc.
 All rights reserved.
 
+Welcome to the Omnistudio Migration Assistant Pilot. This is a pilot tool release and your feedback is invaluable. This migration assistant which is provided for pilot evaluation purposes only and Pilot participants agree to provide feedback as requested.
+
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

README.md

@@ -10,6 +10,8 @@ The Omnistudio Migration Assistant is a command-line interface (CLI) plugin that
 
 - To deploy LWC as part of auto-deployment process, environment variable 'OMA_AUTH_KEY' should be set with requested NPM repository access key from Salesforce Customer Support.
 
+- LWC migration auto-deployment needs minimum node version of 18.17.1
+
 ## Install and Run the Omnistudio Migration Assistant
 
 1. Install SF cli using the official documentation located [here](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
@@ -121,12 +123,19 @@ OPTIONS
   -a, --allversions                                                                 migrate all versions and not
                                                                                     and not just the active ones.
 
-  --only=only                                                                       specify components to assess:
-                                                                                    dm (Data Mappers), ip (Integration Procedures),
-                                                                                    os (OmniScripts), fc (FlexCards), autonumber (Omni Global Auto Numbers)
+  --only=only                                                                       specify any single components to migrate:
+                                                                                    dm (Data Mappers),
+                                                                                    ip (Integration Procedures),
+                                                                                    os (Omniscripts),
+                                                                                    fc (Flexcards),
+                                                                                    autonumber (Omni Global Auto Numbers),
+                                                                                    cl (Custom Labels)
 
-  --relatedobjects=relatedobjects                                                   specify related objects to assess:
-                                                                                    'apex' for Apex classes
+  --relatedobjects=relatedobjects(comma separated)                                  specify one or more related objects to assess:
+                                                                                    'apex'       for Apex classes
+                                                                                    'lwc'        for LWC (Lightning Web Components)
+                                                                                    'expsites'   for Experience Sites
+                                                                                    'flexipage'  for FlexiPages
 ```
 
 ### Migrate Usage & parameters
@@ -149,20 +158,21 @@ OPTIONS
   -a, --allversions                                                                 migrate all versions and not
                                                                                     and not just the active ones.
 
-  --only=only                                                                       specify components to migrate:
-                                                                                    dm (DataMappers), ip (Integration Procedures),
-                                                                                    os (OmniScripts), fc (FlexCards)
+  --only=only                                                                       specify any single components to migrate:
+                                                                                    dm (Data Mappers),
+                                                                                    ip (Integration Procedures),
+                                                                                    os (Omniscripts),
+                                                                                    fc (Flexcards),
+                                                                                    autonumber (Omni Global Auto Numbers),
+                                                                                    cl (Custom Labels)
 
-  --relatedobjects=relatedobjects                                                   specify related objects to assess:
+  --relatedobjects=relatedobjects(comma separated)                                  specify one or more related objects to assess:
                                                                                     'apex'       for Apex classes
-'lwc'        for LWC (Lightning Web Components)
-'expsites'   for Experience Sites
-'flexipage'  for Lightning record pages
-
+                                                                                    'lwc'        for LWC (Lightning Web Components)
+                                                                                    'expsites'   for Experience Sites
+                                                                                    'flexipage'  for FlexiPages
 ```
 
-> **Note:** LWC migration auto-deployment needs minimum node version of 18.17.1
-
 Terms:
 Notwithstanding anything stated in the terms and conditions agreed between Salesforce (‘SFDC’) and you (‘Customer’), the use of the OmniStudio Migration Assistant (‘Assistant’) is designed to facilitate the migration and it’s going to modify your custom code and by deploying and using the Assistant you hereby provide your consent to automate the migration process and enable a smooth transition. Customer shall access and use the Assistant only as permitted to the Customer and shall not compromise, break or circumvent any technical processes or security measures associated with the services provided by SFDC.
 The Customer agrees to hold harmless, indemnify, and defend SFDC, and its officers, directors, agents, employees, licensees, successors and assigns (collectively, the “Indemnified Parties”) against any and all damages, penalties, losses, liabilities, judgments, settlements, awards, costs, and expenses (including reasonable attorneys’ fees and expenses) to the extent arising out of or in connection with any claims related to the Customers use of the Assistant or any willful misconduct, fraud or grossly negligent acts or omissions by the Customer.