From 707fa73d0a0b8e1ad55503987148da8f46881c11 Mon Sep 17 00:00:00 2001
From: Arjun Sreedharan <asreedharan@vmware.com>
Date: Fri, 24 Jul 2020 14:28:38 +0000
Subject: [PATCH] Add readme

Signed-off-by: Arjun Sreedharan <asreedharan@vmware.com>
---
 README.md | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e200a78..ecbb2ae 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# dep-ensure
-A Cloud Native Buildpack for installing packages using dep
+# Dep Ensure Cloud Native Buildpack
+
+The Dep Ensure CNB makes use of the [`dep`](https://golang.github.io/dep) tool
+to execute the `dep ensure` command in the working directory of the app. For
+more info about the `dep ensure` command, see the
+[documentation](https://golang.github.io/dep/docs/daily-dep.html#using-dep-ensure)
+
+## Integration
+
+The Dep Ensure CNB does not provide any dependencies. It requires the `dep`
+dependency that can be provided by a buildpack like the [Dep
+CNB](https://github.com/paketo-buildpacks/dep).
+
+## Usage
+
+To package this buildpack for consumption:
+
+```
+$ ./scripts/package.sh
+```
+
+## `buildpack.yml` Configurations
+
+This buildpack does not support configurations using `buildpack.yml`.