git-stack-cli 0.8.7 → 1.0.2

package/README.md

@@ -10,7 +10,6 @@
 - 🚫 **Avoid juggling mutiple branches and complex rebasing**
 - 📚 **Preserve your detailed commit history**
 
-
 ## Demo
 
 > <img src="https://github.com/magus/git-multi-diff-playground/assets/290084/069c304b-80cb-49a9-9dc6-4ed3b061a5bc">
@@ -18,12 +17,16 @@
 ## Install
 
 ```bash
+# node
 npm i -g git-stack-cli
+
+# homebrew
+brew tap magus/git-stack
+brew install git-stack
 ```
 
 ## Usage
 
-
 ```bash
 git stack
 
@@ -46,7 +49,6 @@ Managing stacked diffs manually involves managing multiple local branches, jumpi
 This process gets even more complicated when you start getting feedback in code review and have to update individual branches.
 Managing even a few stacked diffs requires a relatively strong knowledge of `git`, even with tricks like [`--update-refs`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---update-refs).
 
-
 ## How is this different than **`x`**
 
 ### [`ghstack`](https://github.com/ezyang/ghstack)
@@ -62,10 +64,37 @@ Managing even a few stacked diffs requires a relatively strong knowledge of `git
 ## Development
 
 ```bash
+git submodule update --init --recursive
+npm i
 npm run dev
 npm link
 
+# navigate to project to test within
+npm link git-stack-cli
+
 git stack --verbose
 ```
 
+## Build standalone executable
+
+```bash
+npm run build:standalone
+```
+
+## Publishing
 
+> [!IMPORTANT]
+>
+> **You must update the `version` in `package.json` and commit all changes first!**
+
+### NPM
+
+```bash
+npm run release:npm
+```
+
+### Homebrew + Github
+
+```bash
+npm run release:github
+```