diff --git a/README.md b/README.md index 3780828..d82d6fb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ -buildpack-nginx +nginx buildpack =============== -This buildpack will download, compile and configure nginx to deliver static web content inside Stackato or Helion Development Platform. +This buildpack represents the most simple buildpack I could think of that would be helpful when learning how to create buildpacks for Stackato or Helion Development Platform. + +This buildpack will download, compile and configure nginx to deliver static web content from a public directory. + +## How to use + +Include the URL to this repository under the buildpack key in the manifest for your application. + +```yaml +--- +applications: +- name: static-app + buildpack: https://github.com/dwatrous/buildpack-nginx.git +``` + +## Complete explanation available + +http://software.danielwatrous.com/nginx-buildpack-realtime/