docs: mention full profiles in package and command description

amtrack · Dec 20, 2024 · d397d11 · d397d11
1 parent 59cd22d
commit d397d11
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # sfdx-plugin-source-read
 
-> sfdx/sf plugin to read Metadata via CRUD Metadata API
+> sfdx/sf plugin to read Metadata e.g. full Profiles via CRUD Metadata API
 
 For certain Metadata Types there is a different behaviour of the [file-based](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm) vs. [CRUD-based](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readMetadata.htm) Metadata API.
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sfdx-plugin-source-read",
-  "description": "sfdx plugin to read Metadata via CRUD Metadata API",
+  "description": "sfdx plugin to read Metadata e.g. full Profiles via CRUD Metadata API",
   "version": "0.0.0-development",
   "author": "Matthias Rolke @amtrack",
   "bugs": "https://github.com/amtrack/sfdx-plugin-source-read/issues",

diff --git a/src/commands/force/source/read.ts b/src/commands/force/source/read.ts
@@ -16,7 +16,7 @@ import { convertToXml, parseCommaSeparatedValues } from "../../../utils.js";
 export class SourceReadCommand extends SfCommand<any> {
   public static readonly summary = "Read Metadata using the CRUD Metadata API";
   public static readonly description =
-    "Read Metadata using the CRUD Metadata API";
+    "Read Metadata e.g. full Profiles using the CRUD Metadata API";
 
   public static readonly examples = [
     `$ <%= config.bin %> <%= command.id %> -m "Profile:Admin"`,