README.md

   1 # "To install, drag this icon..." no more!
   2
   3 [![Build Status](https://img.shields.io/travis/caskroom/homebrew-cask/master.svg)](https://travis-ci.org/caskroom/homebrew-cask)
   4 [![Code Climate](https://img.shields.io/codeclimate/github/caskroom/homebrew-cask.svg)](https://codeclimate.com/github/caskroom/homebrew-cask)
   5
   6
   7 Let's see if we can get the elegance, simplicity, and speed of Homebrew for the
   8 installation and management of GUI Mac applications such as Google Chrome and Adium.
   9
  10 Homebrew-cask provides a friendly homebrew-style CLI workflow for the
  11 administration of Mac applications distributed as binaries.
  12
  13 It's implemented as a `homebrew` "[external command](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External-Commands.md)"
  14 called `cask`.
  15
  16 ## Let's try it!
  17 ```sh
  18 $ brew install caskroom/cask/brew-cask
  19 $ brew cask install google-chrome
  20 => Downloading https://dl.google.com/chrome/mac/stable/GGRO/googlechrome.dmg
  21 => Success! google-chrome installed to /opt/homebrew-cask/Caskroom/google-chrome/stable-channel
  22 => Linking Google Chrome.app to /Users/phinze/Applications/Google Chrome.app
  23 ```
  24 And there we have it. Google Chrome installed with a few quick commands: no clicking, no dragging, no dropping.
  25 ```sh
  26 $ open ~/Applications/"Google Chrome.app"
  27 ```
  28 ## Learn More
  29
  30  * Find basic documentation on using homebrew-cask in [USAGE.md](USAGE.md)
  31  * Want to contribute a Cask? Awesome! See [CONTRIBUTING.md](CONTRIBUTING.md)
  32  * Want to hack on our code? Also awesome! See [hacking.md](doc/hacking.md)
  33  * More project-related details and discussion are available in [FAQ.md](doc/FAQ.md) and [CASK_LANGUAGE_REFERENCE.md](doc/CASK_LANGUAGE_REFERENCE.md)
  34
  35 ## Questions? Wanna chat?
  36
  37 We're really rather friendly! Here are the best places to talk about the project:
  38
  39  * Start an [issue on GitHub](https://github.com/caskroom/homebrew-cask/issues/new)
  40  * Join us on IRC, we're at `#homebrew-cask` on Freenode
  41
  42 ## Reporting Bugs
  43
  44 We still have bugs -- and we are busy fixing them!  If you have a problem, don't
  45 be shy about reporting it on our [GitHub issues page](https://github.com/caskroom/homebrew-cask/issues?state=open).
  46
  47 When reporting bugs, remember that homebrew-cask is an independent project from
  48 Homebrew.  Do your best to direct bug reports to the appropriate project.  If
  49 your command-line started with `brew cask`, bring the bug to us first!
  50
  51 Before reporting a bug, make sure you have the latest versions of Homebrew,
  52 homebrew-cask, and all Taps by running the following command:
  53
  54 ```bash
  55 $ brew update && brew upgrade brew-cask && brew cleanup && brew cask cleanup
  56 ```
  57
  58 ## License:
  59 Code is under the [BSD 2 Clause (NetBSD) license](LICENSE)