aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Library/Homebrew/README.md')
-rw-r--r--Library/Homebrew/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md
new file mode 100644
index 000000000..f154675e2
--- /dev/null
+++ b/Library/Homebrew/README.md
@@ -0,0 +1,4 @@
+# Homebrew Public API
+We're (finally) working on a documented public API for Homebrew. It's currently a work in progress; a bunch of public stuff is documented and a bunch of private stuff is undocumented. Sorry about that!
+
+The main class you should look at is {Formula}. Assume everything else is private for now.