From 6888394dfa4e2d5ac50801fd62a24fb2ca7a2b27 Mon Sep 17 00:00:00 2001
From: Gabriel Gonzalez <gabriel@awakenetworks.com>
Date: Tue, 14 Feb 2017 15:39:58 -0800
Subject: [PATCH] Add instructions on how to install and run
 `compile-proto-file` (#91)

You can use `nix-env` to install any derivation that outputs binaries underneath
a `bin/` directory, so we can reuse `nix-env` for installing binaries built by
this project.
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 68d314e..e83d586 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
+Installation
+------------
+
+Run the following command from the root of this repository to install the
+`compile-proto-file` executable:
+
+```bash
+$ nix-env -iA grpc-haskell -f release.nix
+```
+
+Usage
+-----
+
+```bash
+$ compile-proto-file --help
+Dumps a compiled .proto file to stdout
+
+Usage: compile-proto-file --proto FILEPATH
+
+Available options:
+  -h,--help                Show this help text
+  --proto FILEPATH         Path to input .proto file
+```
+
 Building and testing
 --------------------