git-stack-cli 2.6.0 → 2.7.0

package/README.md

@@ -58,6 +58,15 @@ git stack --no-verify # skip git hooks such as pre-commit and pre-push
 git stack help        # print a table of all CLI arguments
 ```
 
+### Adding new commits and pull requests
+
+Adding commits to a PR is as simple as running `git stack` and adding commits to a PR.
+
+1. Run `git stack`
+1. Press `c` to create a new PR
+1. Use `↑↓` and `space`/`enter` to navigate and assign commits to the PR
+1. Press `s` to sync created PRs and commits to Github
+
 ### Editing existing commits and pull requests
 
 Sometimes you want to add changes to an existing commit or pull request.
@@ -87,19 +96,29 @@ To update your local branch with the latest changes in the remote branch (e.g. `
 git stack rebase
 ```
 
-### Customizing branch name
+### Branch names
+
+By default `git stack` generates a unique identifier and appends it to your local branch name.
 
-By default `git stack` generates a unique branch name such as `gs-3cmrMBSUj`.
+For example, if you are locally working in `dev/feature-a`, PRs branch names will look like `dev/feature-a-3cmrMBSUj`.
 
-You can specify a prefix for the generated branch name by using either the environment variable or the command line option.
-In the example below branches would be generated such as `dev/magus/gs-3cmrMBSUj`.
+### Overriding defaults
+
+`git stack` has many optional flags to control its behavior.
+You can view them by running `git stack help` and set them as needed.
+
+If you prefer to set them once in your environment, you can use the command below to generate a one-time configuration.
 
 ```bash
-GIT_STACK_BRANCH_PREFIX="dev/magus/" git stack
+❯ git stack config --draft --force
 
-git stack --branch-prefix="dev/magus/"
+Add the line below to your shell rc file (.zshrc, .bashrc, etc.)
+
+export GIT_STACK_CONFIG="{\"draft\":true,\"force\":true}"
 ```
 
+Copy this environment variable into your shell configuration, e.g. `.zshrc`, `.bashrc`, etc.
+
 ## Why?
 
 The goal of `git stack` is to combine the **simplicity of developing in a single branch** in order to **preserve your commit history** while also **grouping commits into pull requests for code review**.