Skip to content

Commit 93fc807

Browse files
authored
Update README.md
1 parent 59ac6df commit 93fc807

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ Generates a metadata package (`package.xml` & source files) for differences betw
77
![Generating vs working tree](https://user-images.githubusercontent.com/5217568/65200914-e587ed80-da45-11e9-917d-a63a3c91b29f.gif)
88
*Example Generating vs "working tree" & master*
99

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

1218
- ApexClass
@@ -17,21 +23,13 @@ Generates a metadata package (`package.xml` & source files) for differences betw
1723
- CustomField
1824
- StaticResources
1925
- all other simple *-meta.xml files
26+
- Destructive Changes!
2027

2128
**Not yet supported:**
2229

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

3634
## Usage
3735

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

9391
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.
9492

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+
95103

96104
## Disclaimer
97105

0 commit comments

Comments
 (0)