Write basic readme

kamcma · Aug 25, 2017 · a1e5470 · a1e5470
1 parent 2462121
commit a1e5470
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# X-Forwarded-Proto SSL middleware for Vapor
+# X-Forwarded-Proto SSL Middleware for Vapor
+
+A Vapor middleware to redirect reverse proxy requests originating as http to https.
+
+# Usage
+
+To use Vapor X-Forwarded-Proto Middleware, add the middleware to your `Config` and your `droplet.json`:
+
+```swift
+let config = Config()
+let xfpMiddleware = XFPMiddleware()
+config.addConfigurable(middleware: xfpMiddleware, name: "xfp-middleware")
+let drop = try Droplet(config)
+```