Conform to tap template (#15)

qmk · Jul 2, 2021 · dc8b282 · dc8b282
1 parent 866128f
commit dc8b282
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/mdloader.rb → Formula/mdloader.rb b/mdloader.rb → Formula/mdloader.rb
diff --git a/qmk.rb → Formula/qmk.rb b/qmk.rb → Formula/qmk.rb
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
-# QMK homebrew
+# QMK Homebrew
 
-Homebrew formulas for QMK software.
+This repository contains Homebrew formulae for QMK software.
+
+## How do I install these formulae?
+
+`brew install qmk/qmk/<formula>`
+
+Or `brew tap qmk/qmk` and then `brew install <formula>`.
+
+## Documentation
+
+`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).