📝 adding documentation

Author: carbontwelve

README.md

@@ -0,0 +1,63 @@
+# Tapetry Asset Plugin
+
+## Install
+
+To install run: `composer require tapestry-cloud/code-example-plugin`
+ 
+Next you need to update your site configuration to include the path to your code examples folder: 
+
+```php
+// ...
+
+    'plugins' => [
+        'code_example_path' => __DIR__ . '/code_examples/'
+    ],
+
+// ...
+```
+
+Finally within your site Kernel.php you need to register the plugin's service provider:
+
+```php
+<?php
+
+use Tapestry\Modules\Kernel\KernelInterface;
+
+class Kernel implements KernelInterface
+{
+    /**
+     * @var Tapestry
+     */
+    private $tapestry;
+    
+    public function __construct(Tapestry $tapestry)
+    {
+        $this->tapestry = $tapestry;
+    }
+    
+    /**
+     * This method is executed by Tapestry when the Kernel is registered.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        // Use project autoloader
+        require_once(__DIR__ . '/vendor/autoload.php');
+    }
+    
+    /**
+     * This method of executed by Tapestry as part of the build process.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->tapestry->register(\TapestryCloud\CodeExample\ServiceProvider::class);
+    }
+}
+```
+
+## Usage
+
+This plugin adds the `$this->codeExample('example.php')` helper, which will output your code examples with their html entities encoded. 

src/CodeExamplePlatesExtension.php

@@ -34,11 +34,10 @@ public function register(Engine $engine)
      */
     public function codeExample($file)
     {
-        $this->codeExamplesPath = __DIR__ . '/../source/_code-examples/' . $file;
-        if (! file_exists($this->codeExamplesPath)) {
-            throw new \Exception('File ['. $this->codeExamplesPath .'] does not exist.');
+        if (!file_exists($this->codeExamplesPath . $file)) {
+            throw new \Exception('File [' . $this->codeExamplesPath . $file . '] does not exist.');
         }
 
-        return htmlentities(file_get_contents($this->codeExamplesPath));
+        return htmlentities(file_get_contents($this->codeExamplesPath . $file));
     }
 }