README.md

   1 # git-purged
   2 git-purged - a git sub command to list branches already removed on remote origin
   3
   4 ## Overview
   5
   6 A tiny tool to list branches which are already purged from a remote origin. A cross-platform and easy-to-use alternative for grep'ing `git`'s output. The main purpose of the `git-purged` is to provide a convinient way for scripting deletion of obsolete git branches.
   7
   8 ## Build
   9
  10 Since the tool was intentionally written with using no external dependencies, the following should be enough to a get a self-contained binary:
  11
  12     make build
  13
  14 will produce `git-purged` (`git-purged.exe` for MS Windows) binary in `build/` directory.
  15
  16 ## Usage
  17
  18 The only requirement is `git` command availability through `${PATH}` (`%PATH%`) global environment variable.
  19
  20 ### List purged
  21
  22 Run with not arguments. Default behavior.
  23
  24 ### List non-purged
  25
  26     git-purged --inverse
  27
  28 # License
  29
  30 MIT
  31