goatee 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4968c0c33b69b0e7fca62a45dfabc9ea3225d8f
-  data.tar.gz: 1de1c6fc689a76ac14c855a8785370236ca83335
+  metadata.gz: 85225246cc9a3c84d5d362b47e26c58ca8d3178b
+  data.tar.gz: 2470113bc1fe39ece17204f29d18e407d86eb473
 SHA512:
-  metadata.gz: 83d1e05555a2629409b7cc02356c94bb19f18d637411fc6cd0738203245d692c0b0f8e3f08390203f541ad702415d14f3d7c46998a2f9057acd32c6ddd459f09
-  data.tar.gz: 362ee9765dcc39b503de16de89ff7f0f1551ac6b36a45cdd156b9c5909c93c3c3f6e81cd759b4c2dc8a80888966132989943d943dd21c710d1c3f90bd6393cd3
+  metadata.gz: 2dda6639a3df6f2d38220ffe4618768991f0513aeab79ec8546a5d6d218b086c8ba2e6b4e7e00d6706034062bb2ecdbaaf9b2541115273c879e7ffab89acec44
+  data.tar.gz: e9557f6e9e8ea182959bf5d1c33b29f585aef60e1a0fc74e2e0041d9cf133b4b85aa7676bc0b74e01c6d401a4f1b84e9aa8102709a29e841b589c07d5fde75c6

data/README.md

@@ -13,7 +13,71 @@ Inspired by [mustache](https://github.com/mustache/mustache). **Goatee** wraps E
 ### Config
 
 ```ruby
-# TODO
+require "goatee"
+
+Goatee.configure do |c|
+  c.templates_directory = "/path/to/templates"
+end
+```
+
+### Basic Usage
+
+Create a **View**
+
+```ruby
+require "goatee"
+
+module View
+  class Login < Goatee::View
+    def initialize(name)
+      @name = name
+    end
+
+    def render(name)
+      super "login"
+    end
+
+    def name
+      @name.capitalize
+    end
+  end
+end
+```
+
+Create a **Template**
+
+```html
+<h1>Login Page</h1>
+<p>
+  Hello <%= name %>
+</p>
+```
+
+**Render** it
+
+```ruby
+require "view/login"
+
+View::Login.new("batman").render
+```
+
+### Partials
+
+Include a partial by using the `include` keyword in an **ERB template**
+
+```html
+<%= include "header" %>
+
+<h1>Login Page</h1>
+<p>
+  Hello <%= name %>
+</p>
+```
+
+This will render the partial **located** at
+
+```
+<templates_directory>/includes/<partial_id>.erb
 ```
 
 ### Credits

data/lib/goatee/version.rb

@@ -1,3 +1,3 @@
 module Goatee
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goatee
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Charlie Revett