sf-raven 1.2.1 → 1.2.3

package/README.md

@@ -1,12 +1,31 @@
-# sf-raven
-
-[![NPM](https://img.shields.io/npm/v/sf-raven.svg?label=sf-raven)](https://www.npmjs.com/package/sf-raven) [![Downloads/week](https://img.shields.io/npm/dw/sf-raven.svg)](https://npmjs.org/package/sf-raven) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/sf-raven/main/LICENSE.txt)
-
-A plugin for the Salesforce CLI built by Tom Carman.
-
-[sf-raven](https://github.com/tomcarman/sf-raven) now replaces [sfdx-raven](https://github.com/tomcarman/sfdx-raven/).
-
-## Command Quick Reference
+<div align="center">
+    <img src="media/logo/sf-raven-roundrect.png" width="300px" align="center" alt="sf raven logo" />
+    <br/><br/>
+    <b>Salesforce CLI plugin by @tomcarman</b>
+    <br/><br/>
+  
+  [![NPM](https://img.shields.io/npm/v/sf-raven.svg?label=sf-raven)](https://www.npmjs.com/package/sf-raven) [![Downloads/week](https://img.shields.io/npm/dw/sf-raven.svg)](https://npmjs.org/package/sf-raven) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/sf-raven/main/LICENSE.txt)
+
+</div>
+</br>
+
+## Overview
+
+* [Features](#features)
+* [Install](#install)
+* [Command Reference](#command-reference)
+  * [sf raven object display fields](#sf-raven-object-display-fields)
+  * [sf raven object display recordtypes](#sf-raven-object-display-recordtypes)
+  * [sf raven pull](#sf-raven-pull)
+  * [sf raven pull remote](#sf-raven-pull-remote)
+  * [sf raven deploy cancel](#sf-raven-deploy-cancel)
+  * [sf raven query ids](#sf-raven-query-ids)
+  * [sf raven audit display](#sf-raven-audit-display)
+  * [sf raven event subscribe](#sf-raven-event-subscribe)
+
+</br>
+
+## Features
 
 Full details, usage, examples etc are further down, or can be accessed via `--help` on the commands.
 
@@ -52,7 +71,7 @@ Full details, usage, examples etc are further down, or can be accessed via `--he
 * [sfdx raven:utils:dashboarduser:update](#sfdx-ravenutilsdashboarduserupdate)
   * Change the running user of Dashboards -->
 
-## Setup
+## Install
 
 ### Dependencies
 * [fzf](https://github.com/junegunn/fzf) is required for the [sf raven pull](#sf-raven-pull) commands, and should be available on your path. (IMO they are probably the most useful commands in this plugin, so its worth setting up fzf if you don't have it.)
@@ -78,12 +97,15 @@ The plugin can be updated to the latest version using
 3. Install npm modules: `npm install`
 4. Link the plugin: `sfdx plugins:link .`
 
-## Compatibility
+### Compatibility
 
 - **macOS**
   - Plugin has been built on macOS and will always run on macOS
 
-## sf raven object display fields
+
+## Command Reference
+
+### sf raven object display fields
 
 Show field information for a given sObject.
 
@@ -124,7 +146,7 @@ Annual Revenue     AnnualRevenue   Currency(18, 0)
 ...
 ```
 
-## sf raven object display recordtypes
+### sf raven object display recordtypes
 
 Show RecordType information for a given sObject.
 
@@ -164,7 +186,7 @@ Person Account      PersonAccount           0124J000000YYYYDEF
 ...
 ```
 
-## sf raven pull
+### sf raven pull
 
 Update Salesforce metadata into the local project via a fuzzy finder.
 
@@ -192,7 +214,7 @@ EXAMPLES
   $ sf raven pull --target-org dev --all
 ```
 
-## sf raven pull remote
+### sf raven pull remote
 
 Retrieve Salesforce metadata that exists in the org but not locally, via a fuzzy finder.
 
@@ -215,7 +237,7 @@ EXAMPLES
   $ sf raven pull remote --target-org dev
 ```
 
-## sf raven deploy cancel
+### sf raven deploy cancel
 
 Cancel a pending or in-progress Salesforce deploy.
 
@@ -238,7 +260,7 @@ EXAMPLES
   $ sf raven deploy cancel --target-org dev
 ```
 
-## sf raven query ids
+### sf raven query ids
 
 Run a SOQL query against a large list of Salesforce IDs.
 
@@ -270,7 +292,7 @@ EXAMPLES
   $ sf raven query ids --file account-ids.txt --query "SELECT Id, Name FROM Account WHERE Id IN {ids}" --csv results.csv
 ```
 
-## sf raven audit display
+### sf raven audit display
 
 Show recent entries in the Setup Audit Trail.
 
@@ -310,7 +332,7 @@ Date                Username      Type         Action
 ...
 ```
 
-## sf raven event subscribe
+### sf raven event subscribe
 
 Subscribe to Platform Events, streamed to your terminal.
 
@@ -359,7 +381,7 @@ OUTPUT
 }
 ```
 
-<!-- ## sfdx raven:utils:deploy:branch2org
+<!-- ### sfdx raven:utils:deploy:branch2org
 
 Deploys a git branch to an org. Assumes you have git installed the neccessary access to the repo you are trying to clone (eg. you can run `git clone ...`), and that the branch is in a source-format sfdx project structure.
 
@@ -415,7 +437,7 @@ OUTPUT
 https://wise-hawk-22uzds-dev-ed.my.salesforce.com/lightning/setup/DeployStatus/page?address=%2Fchangemgmt%2FmonitorDeploymentsDetails.apexp%3FasyncId%3D0Af4K00000BHVuASAX
 ```
 
-## sfdx raven:utils:diff
+### sfdx raven:utils:diff
 
 Allows you to quickly compare metadata of files between two orgs. Intended to be used for quick compares of single
 (or possibly a few) files of the same metadata type, rather than a full org compare (there are better tools for
@@ -479,7 +501,7 @@ OUTPUT
 <img width="795" alt="diff" src="https://user-images.githubusercontent.com/1554713/111902572-057edf80-8a36-11eb-8c45-56c09c290e89.png">
 
 
-## sfdx raven:utils:dashboarduser:update
+### sfdx raven:utils:dashboarduser:update
 
 Updates the "Running User" of Dashboards from a given user, to an alternate given user. Useful for mass-updating Dashboards when a user is deactivated.