Add readme

readme.md

@@ -0,0 +1,99 @@
+# Transform PHP Vars to JavaScript
+
+Often, you'll find yourself in situations, where you want to pass some server-side string/array/collection/whatever
+to your JavaScript. Traditionally, this can be a bit of a pain - especially as your app grows.
+
+This package simplifies the process drastically.
+
+## Installation
+
+Begin by installing this package through Composer.
+
+### Laravel Users
+
+If you are a Laravel user, then there is a service provider that you can make use to automatically prepare the bindings and such.
+
+```php
+
+// app/config/app.php
+
+'providers' => [
+    '...',
+    'Laracasts\Utilities\UtilitiesServiceProvider'
+];
+```
+
+When this provider is booted, you'll have access to a helpful `Give` facade, which you may use in your controllers.
+
+```php
+public function index()
+{
+    Give::javaScript([
+        'foo' => 'bar',
+        'user' => User::first(),
+        'age' => 29
+    ]);
+
+    return View::make('hello');
+}
+```
+
+Using the code above, you'll now be able to access `foo`, `user`, and `age` from your JavaScript.
+
+### Defaults
+
+There are only two configuration options that you'll need to worry about. First, publish the default configuration.
+
+```bash
+php artisan config:publish laracasts/utilities
+```
+
+This will add a new configuration file to: `app/config/packages/laracasts/utilities`.
+
+```php
+
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | View to Bind JavaScript Vars To
+    |--------------------------------------------------------------------------
+    |
+    | Set this value to the name of the view (or partial) that
+    | you want to prepend the JavaScript variables to.
+    |
+    */
+    'bind_js_vars_to_this_view' => 'hello',
+
+    /*
+    |--------------------------------------------------------------------------
+    | JavaScript Namespace
+    |--------------------------------------------------------------------------
+    |
+    | By default, we'll add variables to the global window object.
+    | It's recommended that you change this to some namespace - anything.
+    | That way, from your JS, you may do something like `Laracasts.myVar`.
+    |
+    */
+    'js_namespace' => 'window'
+
+];
+```
+
+#### bind_js_vars_to_this_view
+
+If you're using the Laravel service provider with this package, then you need to update this file to specify
+which view you want the new transformed JavaScript variables to be prepended to. Typically, your footer is a good place for this.
+If you have something like a `layouts/partials/footer' partial, where you store your footer and script references, then make the
+`bind_js_vars_to_this_view` key equal to that path. Behind the scenes, this package will listen for when that view is composed, and essentially paste the JS variables within it.
+
+#### js_namespace
+
+By default, all JavaScript vars will be nested under the global `window` object. You'll likely want to change this. Update the
+`js_namespace` key with the name of your desired JavaScript namespace. It can be anything. Just remember: if you change this setting (which you should),
+then you'll access all variables, like so:
+
+```js
+MyNewNamespace.varName
+```