From 76a44ecd58161fc537fb92da8c0fe0be2eb1eb8a Mon Sep 17 00:00:00 2001
From: Matt Moyer <moyerm@vmware.com>
Date: Fri, 14 Aug 2020 14:47:39 -0500
Subject: [PATCH] Add some development notes to the README for now.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 49b59c26..58039403 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
 # placeholder-name
 
 Copyright 2020 VMware, Inc.
+
+## Developing
+
+### Running Lint
+
+```cmd
+./hack/module.sh lint
+```
+
+### Running Tests
+
+```cmd
+./hack/module.sh unittest
+```
+
+### Pre-commit hooks
+
+This project uses the [pre-commit] to agree on some conventions about whitespace/file encoding.
+
+```cmd
+$ brew install pre-commit
+[...]
+$ pre-commit install
+pre-commit installed at .git/hooks/pre-commit
+```
+
+[pre-commit]: https://pre-commit.com/