From 57ccc28d9661fb76c6352d83b89cf86d66ae9c7c Mon Sep 17 00:00:00 2001
From: Mitch Dennett <mitchelldennett2@gmail.com>
Date: Sun, 7 Feb 2021 07:26:40 -0500
Subject: [PATCH] added documentation to README

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1e3f840..8760e2d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,42 @@
-## JTE Plugin for Severell
\ No newline at end of file
+## JTE Plugin for Severell
+
+### Installation
+
+Add the following dependency to your `pom.xml`
+
+```
+<dependency>
+    <groupId>com.severell.plugins</groupId>
+    <artifactId>jte</artifactId>
+    <version>0.0.2/version>
+</dependency>
+```
+
+Then in your `providers.java` you'll need to add the `JteProvider.java`. The provider list should look something like this
+
+```java
+    public static ServiceProvider[] load(Container c) {
+        return new ServiceProvider[]{
+                new AppProvider(c),
+                new JettyProvider(c),
+                new SessionProvider(c),
+                new ViewProvider(c),
+                new JteProvider(c),
+                new MailProvider(c),
+                new RouteProvider(c),
+        };
+    }
+```
+Finally in your `.env` file you'll need to add the following variable.
+
+```text
+VIEW_DRIVER=Jte
+```
+
+### Usage
+
+Now in your controller files you can render your Jte templates.
+
+```java
+resp.render("index.jte", new HashMap<String, Object>());
+```
\ No newline at end of file