Skip to content

Commit ec14b8e

Browse files
committed
Merge branch 'master' of github.com:ChuckJonas/sfdx-git-packager
2 parents 968260f + 93fc807 commit ec14b8e

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
# sfdx-git-packager
22

3+
![npm](https://img.shields.io/npm/v/sfdx-git-packager)
4+
35
Generates a metadata package (`package.xml` & source files) for differences between two branches/commits.
46

57
![Generating vs working tree](https://user-images.githubusercontent.com/5217568/65200914-e587ed80-da45-11e9-917d-a63a3c91b29f.gif)
68
*Example Generating vs "working tree" & master*
79

10+
## Install
11+
12+
Run `sfdx plugins:install sfdx-git-packager`
13+
14+
## Features
15+
816
**Currently supports:**
917

1018
- ApexClass
@@ -16,20 +24,12 @@ Generates a metadata package (`package.xml` & source files) for differences betw
1624
- CustomField
1725
- StaticResources
1826
- all other simple *-meta.xml files
27+
- Destructive Changes!
1928

2029
**Not yet supported:**
2130

2231
- ??? (please submit an issue if you run into anything else)
23-
- Windows :/ (help wanted)
24-
25-
## Installation
26-
27-
(`NPM` based install coming soon)
28-
29-
1. git clone
30-
1. cd
31-
1. `yarn/npm` install
32-
1. `sfdx plugins:link`
32+
- Windows (needs testing)
3333

3434
## Usage
3535

@@ -90,6 +90,16 @@ _See code: [lib/commands/git/package.js](https://github.com/ChuckJonas/sfdx-git-
9090

9191
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.
9292

93+
## Developing
94+
95+
(`NPM` based install coming soon)
96+
97+
1. git clone
98+
1. cd
99+
1. `yarn/npm` install
100+
1. `sfdx plugins:link`
101+
102+
93103

94104
## Disclaimer
95105

0 commit comments

Comments
 (0)