goatee 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +65 -1
  3. data/lib/goatee/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e4968c0c33b69b0e7fca62a45dfabc9ea3225d8f
4
- data.tar.gz: 1de1c6fc689a76ac14c855a8785370236ca83335
3
+ metadata.gz: 85225246cc9a3c84d5d362b47e26c58ca8d3178b
4
+ data.tar.gz: 2470113bc1fe39ece17204f29d18e407d86eb473
5
5
  SHA512:
6
- metadata.gz: 83d1e05555a2629409b7cc02356c94bb19f18d637411fc6cd0738203245d692c0b0f8e3f08390203f541ad702415d14f3d7c46998a2f9057acd32c6ddd459f09
7
- data.tar.gz: 362ee9765dcc39b503de16de89ff7f0f1551ac6b36a45cdd156b9c5909c93c3c3f6e81cd759b4c2dc8a80888966132989943d943dd21c710d1c3f90bd6393cd3
6
+ metadata.gz: 2dda6639a3df6f2d38220ffe4618768991f0513aeab79ec8546a5d6d218b086c8ba2e6b4e7e00d6706034062bb2ecdbaaf9b2541115273c879e7ffab89acec44
7
+ data.tar.gz: e9557f6e9e8ea182959bf5d1c33b29f585aef60e1a0fc74e2e0041d9cf133b4b85aa7676bc0b74e01c6d401a4f1b84e9aa8102709a29e841b589c07d5fde75c6
data/README.md CHANGED
@@ -13,7 +13,71 @@ Inspired by [mustache](https://github.com/mustache/mustache). **Goatee** wraps E
13
13
  ### Config
14
14
 
15
15
  ```ruby
16
- # TODO
16
+ require "goatee"
17
+
18
+ Goatee.configure do |c|
19
+ c.templates_directory = "/path/to/templates"
20
+ end
21
+ ```
22
+
23
+ ### Basic Usage
24
+
25
+ Create a **View**
26
+
27
+ ```ruby
28
+ require "goatee"
29
+
30
+ module View
31
+ class Login < Goatee::View
32
+ def initialize(name)
33
+ @name = name
34
+ end
35
+
36
+ def render(name)
37
+ super "login"
38
+ end
39
+
40
+ def name
41
+ @name.capitalize
42
+ end
43
+ end
44
+ end
45
+ ```
46
+
47
+ Create a **Template**
48
+
49
+ ```html
50
+ <h1>Login Page</h1>
51
+ <p>
52
+ Hello <%= name %>
53
+ </p>
54
+ ```
55
+
56
+ **Render** it
57
+
58
+ ```ruby
59
+ require "view/login"
60
+
61
+ View::Login.new("batman").render
62
+ ```
63
+
64
+ ### Partials
65
+
66
+ Include a partial by using the `include` keyword in an **ERB template**
67
+
68
+ ```html
69
+ <%= include "header" %>
70
+
71
+ <h1>Login Page</h1>
72
+ <p>
73
+ Hello <%= name %>
74
+ </p>
75
+ ```
76
+
77
+ This will render the partial **located** at
78
+
79
+ ```
80
+ <templates_directory>/includes/<partial_id>.erb
17
81
  ```
18
82
 
19
83
  ### Credits
@@ -1,3 +1,3 @@
1
1
  module Goatee
2
- VERSION = "0.0.1".freeze
2
+ VERSION = "0.0.2".freeze
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: goatee
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Charlie Revett