Add readme

tjdraper · Dec 20, 2016 · 8787e95 · 8787e95
1 parent 7794085
commit 8787e95
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -0,0 +1,16 @@
+# Auto Link Twig Filter for Craft
+
+Just like the label on the box suggests, this is a simple Twig filter that will turn URLs in a string into clickable HTML anchors.
+
+## Installation
+
+1. Put the `autolink` directory in `craft/plugins`
+2. Go into the Craft control panel and navigate to `settings -> plugins` and click install on the Auto Link item.
+
+## Usage
+
+You can use the Twig filter on any string variable like so:
+
+```
+{{ myStringVar|autolink }}
+```