1 files changed, 36 insertions, 0 deletions
diff --git a/Library/Homebrew/dev-cmd/tap-readme.rb b/Library/Homebrew/dev-cmd/tap-readme.rb
new file mode 100644
index 000000000..ad115a53e
--- /dev/null
+++ b/Library/Homebrew/dev-cmd/tap-readme.rb
@@ -0,0 +1,36 @@
+#: @hide_from_man_page
+#:  * `tap_readme` [`-v`] <name>:
+#:    Generate the README.md file for a new tap.
+
+module Homebrew
+  def tap_readme
+    name = ARGV.first
+    raise "A name is required" if name.nil?
+
+    titleized_name = name.dup
+    titleized_name[0..0] = titleized_name[0..0].upcase
+
+    template = <<-EOS.undent
+    # Homebrew #{titleized_name}
+
+    ## How do I install these formulae?
+    `brew install homebrew/#{name}/<formula>`
+
+    Or `brew tap homebrew/#{name}` and then `brew install <formula>`.
+
+    Or install via URL (which will not receive updates):
+
+    ```
+    brew install https://raw.githubusercontent.com/Homebrew/homebrew-#{name}/master/<formula>.rb
+    ```
+
+    ## Documentation
+    `brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme).
+    EOS
+
+    puts template if ARGV.verbose?
+    path = HOMEBREW_LIBRARY/"Taps/homebrew/homebrew-#{name}/README.md"
+    raise "#{path} already exists" if path.exist?
+    path.write template
+  end
+end