README.md in git-up-0.5.2 vs README.md in git-up-0.5.3
- old
+ new
@@ -13,18 +13,27 @@
`git-up` might mess up your branches, or set your chest hair on fire, or be racist to your cat, I don't know. It works for me.
configuration
-------------
-`git-up` can check your app for any new bundled gems and suggest a `bundle install` if necessary.
+`git-up` has a few configuration options, which use git's configuration system. Each can be set either globally or per-project. To set an option globally, append the `--global` flag to `git config`, which you can run anywhere:
-It slows the process down slightly, and is therefore enabled by setting `git-up.bundler.check` to `true` in your git config, either globally or per-project. To set it globally, run this command anywhere:
-
git config --global git-up.bundler.check true
-To set it within a project, run this command inside that project's directory:
+To set it within a project, run the command inside that project's directory and omit the `--global` flag:
+ cd myproject
git config git-up.bundler.check true
-Replace 'true' with 'false' to disable checking.
+### `git-up.bundler.check [true|false]`
-If you're even lazier, you can tell `git-up` to run `bundle install` for you if it finds missing gems. Simply set `git-up.bundler.autoinstall` to `true`, in the same manner. As above, it works globally or per-project, but make sure `git-up.bundler.check` is also set to `true` or it won't do anything.
+If set to `true`, `git-up` will check your app for any new bundled gems and suggest a `bundle install` if necessary.
+
+It slows the process down slightly, and therefore defaults to `false`.
+
+### `git-up.bundler.autoinstall [true|false]`
+
+If you're even lazier, you can tell `git-up` to run `bundle install` for you if it finds missing gems. Make sure `git-up.bundler.check` is also set to `true` or it won't do anything.
+
+### `git-up.fetch.prune [true|false]`
+
+By default, `git-up` will append the `--prune` flag to the `git fetch` command if your git version supports it (1.6.6 or greater), telling it to [delete any branches which no longer exist on the remote](http://linux.die.net/man/1/git-fetch). Set this option to `false` to disable it.
\ No newline at end of file