From fc40a8ce05a84bd42ca41ab4241e9353495438c7 Mon Sep 17 00:00:00 2001
From: Robert Reinhard <robert.reinhard@bkwld.com>
Date: Tue, 19 Jul 2016 16:31:40 -0700
Subject: [PATCH] Adding a readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1025664
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Laravel Pug
+
+[![Packagist](https://img.shields.io/packagist/v/bkwld/laravel-pug.svg)](https://packagist.org/packages/bkwld/laravel-pug)
+
+A small package that adds support for compiling Pug (Jade) templates to Laravel via [Pug.php](https://github.com/pug-php/pug).  Both vanilla php and [Blade syntax](http://laravel.com/docs/5.2/templates#blade-templating) is supported within the view.
+
+
+
+## Installation
+
+1. Run `composer require bkwld/laravel-pug`
+2. Add the service provider to your app.php providers: `Bkwld\LaravelPug\ServiceProvider::class,`
+
+
+
+## Configuration
+
+All [Pug.php](https://github.com/pug-php/pug) config options are passed through via a Laravel config array.
+
+* **Laravel 4** : Publish the config file with `php artisan config:publish bkwld/laravel-pug` and edit at /app/config/packages/bkwld/laravel-pug/config.php
+* **Laravel 5** : Publish the config file with `php artisan vendor:publish --provider="Bkwld\LaravelPug\ServiceProvider"` and edit it at /config/pug.php.  
+
+
+
+## Usage
+
+Laravel Pug registers the ".pug", ".pug.php", ".pug.blade", and ".pug.blade.php" as well as the ".jade", ".jade.php", ".jade.blade", and ".jade.blade.php" extensions with Laravel and forwards compile requests on to Pug.php.  It compiles your Pug templates in the same way as Blade templates; the compiled template is put in your storage directory.  Thus, you don't suffer compile times on every page load.
+
+In other words, just put your Pug files in the regular views directory and name them like "whatever.pug".  You reference them in Laravel like normal:
+
+* **Laravel 4** : `View::make('home.whatever')` for `app/views/home/whatever.pug`
+* **Laravel 5** : `view('home.whatever')` for `resources/views/home/whatever.pug`
+
+The Pug view files can work side-by-side with regular PHP views.  To use Blade templating within your Pug, just name the files with ".pug.blade" or ".pug.blade.php" extensions.
+
+
+
+## Histoy
+
+Read the Github [project releases](https://github.com/BKWLD/laravel-pug/releases) for release notes.