From 59ac6df71139d038ce2c791a8450843650b5d7f8 Mon Sep 17 00:00:00 2001 From: Charlie Jonas Date: Sat, 19 Oct 2019 19:28:11 -0600 Subject: [PATCH 1/2] added npm badge --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2864f19..521fd5e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # sfdx-git-packager +![npm](https://img.shields.io/npm/v/sfdx-git-packager) + Generates a metadata package (`package.xml` & source files) for differences between two branches/commits. ![Generating vs working tree](https://user-images.githubusercontent.com/5217568/65200914-e587ed80-da45-11e9-917d-a63a3c91b29f.gif) From 93fc807b875d13626f914146f7dca7d259a2a8eb Mon Sep 17 00:00:00 2001 From: Charlie Jonas Date: Sat, 19 Oct 2019 19:31:38 -0600 Subject: [PATCH 2/2] Update README.md --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 521fd5e..507ac0e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,12 @@ Generates a metadata package (`package.xml` & source files) for differences betw ![Generating vs working tree](https://user-images.githubusercontent.com/5217568/65200914-e587ed80-da45-11e9-917d-a63a3c91b29f.gif) *Example Generating vs "working tree" & master* +## Install + +Run `sfdx plugins:install sfdx-git-packager` + +## Features + **Currently supports:** - ApexClass @@ -17,21 +23,13 @@ Generates a metadata package (`package.xml` & source files) for differences betw - CustomField - StaticResources - all other simple *-meta.xml files +- Destructive Changes! **Not yet supported:** - LWC - ??? (please submit an issue if you run into anything else) -- Windows :/ (help wanted) - -## Installation - -(`NPM` based install coming soon) - -1. git clone -1. cd -1. `yarn/npm` install -1. `sfdx plugins:link` +- Windows (needs testing) ## Usage @@ -92,6 +90,16 @@ _See code: [lib/commands/git/package.js](https://github.com/ChuckJonas/sfdx-git- If you wish to prevent certain files from being included in a package, you can create a `.packageIgnore` in the root of your project. This works similar to [`.gitIgnore`](https://git-scm.com/docs/gitignore). You can add globs to prevent source path from being picked up. +## Developing + +(`NPM` based install coming soon) + +1. git clone +1. cd +1. `yarn/npm` install +1. `sfdx plugins:link` + + ## Disclaimer