Skip to content
Newer
Older
100644 82 lines (48 sloc) 3.7 KB
f01775d @groue README
authored Nov 1, 2010
1 GRMustache
2 ==========
3
acb8902 @groue wording
authored Jan 24, 2012
4 GRMustache is an Objective-C implementation of the [Mustache](http://mustache.github.com/) logic-less template engine.
f01775d @groue README
authored Nov 1, 2010
5
4f1625f @groue guides
authored Jan 24, 2012
6 The Mustache syntax: http://mustache.github.com/mustache.5.html (not wrong, but somewhat outdated).
f01775d @groue README
authored Nov 1, 2010
7
4f1625f @groue guides
authored Jan 24, 2012
8 A list of Mustache implementations in other languages: http://mustache.github.com/
f01775d @groue README
authored Nov 1, 2010
9
4f1625f @groue guides
authored Jan 24, 2012
10 Breaking news on Twitter: http://twitter.com/GRMustache
070c126 @groue dot variable extension
authored Nov 2, 2010
11
f52da9d @groue README+RELEASE_NOTES for GRMustacheNumberFormatterHelper and GRMustac…
authored Jan 24, 2012
12
cf09386 @groue More straightforward README
authored Mar 8, 2012
13 Three steps to GRMustache
14 -------------------------
f52da9d @groue README+RELEASE_NOTES for GRMustacheNumberFormatterHelper and GRMustac…
authored Jan 24, 2012
15
cf09386 @groue More straightforward README
authored Mar 8, 2012
16 ### 1. Download GRMustache
acb8902 @groue wording
authored Jan 24, 2012
17
cf09386 @groue More straightforward README
authored Mar 8, 2012
18 $ git clone https://github.com/groue/GRMustache.git
f5fb58f @groue wording
authored Mar 2, 2012
19
cf09386 @groue More straightforward README
authored Mar 8, 2012
20 ### 2. Embed GRMustache in your Xcode project
945eb6d @groue more README
authored Nov 1, 2010
21
cf09386 @groue More straightforward README
authored Mar 8, 2012
22 - For MacOS 10.6+ development, import `/include/GRMustache.h` and `lib/libGRMustache1-macosx10.6.a` in your project.
23 - For iOS4+ development, import `/include/GRMustache.h` and `lib/libGRMustache1-ios4.a` in your project.
24 - For iOS3+ development, import `/include/GRMustache.h` and `lib/libGRMustache1-ios3.a` in your project.
b5c4640 @groue Expressiveness
authored Mar 5, 2012
25
cf09386 @groue More straightforward README
authored Mar 8, 2012
26 ### 3. Import "GRMustache.h" and start rendering templates
1f63119 @groue wording
authored Feb 9, 2012
27
c3116bd @groue GitHub Flavored Markdown
authored Mar 5, 2012
28 ```objc
29 #import "GRMustache.h"
30
31 NSString *templateString = @"Hello {{name}}!";
32 Person *arthur = [Person personWithName:@"Arthur"];
33
34 // Renders "Hello Arthur!"
35 NSString *rendering = [GRMustacheTemplate renderObject:arthur fromString:templateString error:NULL];
36 ```
f52da9d @groue README+RELEASE_NOTES for GRMustacheNumberFormatterHelper and GRMustac…
authored Jan 24, 2012
37
cf09386 @groue More straightforward README
authored Mar 8, 2012
38 You can also render many times a single template:
1f63119 @groue wording
authored Feb 9, 2012
39
c3116bd @groue GitHub Flavored Markdown
authored Mar 5, 2012
40 ```objc
41 GRMustacheTemplate *template = [GRMustacheTemplate templateFromString:templateString error:NULL];
42 rendering = [template renderObject:arthur];
43 rendering = [template renderObject:...];
44 ```
1f63119 @groue wording
authored Feb 9, 2012
45
f52da9d @groue README+RELEASE_NOTES for GRMustacheNumberFormatterHelper and GRMustac…
authored Jan 24, 2012
46
cf09386 @groue More straightforward README
authored Mar 8, 2012
47 Why GRMustache?
48 ---------------
49
50 GRMustache conforms to the [Mustache specification v1.1.2](https://github.com/mustache/spec).
51
52 GRMustache respects your code: update GRMustache, enjoy [performance improvements](https://github.com/groue/GRMustacheBenchmark) and bugfixes, and don't change a line of your code. You may get harmless deprecation warnings, though (check the [release notes](GRMustache/blob/master/RELEASE_NOTES.md)).
53
54 GRMustache online documentation is provided as guides and sample code:
55
56 - [Guides/templates.md](GRMustache/blob/master/Guides/templates.md): how to parse and render templates
57 - [Guides/runtime.md](GRMustache/blob/master/Guides/runtime.md): how to provide data to templates
58 - [Guides/delegate.md](GRMustache/blob/master/Guides/delegate.md): how to hook into template rendering
59 - [Guides/sample_code.md](GRMustache/blob/master/Guides/sample_code.md): because some tasks are easier to do with some guidelines.
60 - [Guides/forking.md](GRMustache/blob/master/Guides/forking.md): how GRMustache is organized
f52da9d @groue README+RELEASE_NOTES for GRMustacheNumberFormatterHelper and GRMustac…
authored Jan 24, 2012
61
f5fb58f @groue wording
authored Mar 2, 2012
62
c0e699e @groue wip
authored Feb 2, 2012
63 Forking
64 -------
65
d8957ab @groue renamed guides to Guides
authored Mar 5, 2012
66 Please fork. You'll learn useful information in [Guides/forking.md](GRMustache/blob/master/Guides/forking.md).
c0e699e @groue wip
authored Feb 2, 2012
67
f5fb58f @groue wording
authored Mar 2, 2012
68
e4bd74e @groue License
authored Nov 1, 2010
69 License
70 -------
71
72 Released under the [MIT License](http://en.wikipedia.org/wiki/MIT_License)
73
4f1625f @groue guides
authored Jan 24, 2012
74 Copyright (c) 2012 Gwendal Roué
e4bd74e @groue License
authored Nov 1, 2010
75
76 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
77
78 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
79
80 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
81
Something went wrong with that request. Please try again.