Include a basic readme

This commit is contained in:
Kyle Fuller
2014-10-23 18:26:18 +01:00
parent 5382a2b68f
commit 576e952488

View File

@@ -1,2 +1,39 @@
Stencil
=======
Stencil is a simple and powerful template language for Swift. It provides a
syntax similar to Django and Jinja2.
### Example
```html+django
There are {{ articles.count }} articles.
{% for article in articles %}
- {{ article.title }} by {{ article.author }}.
{% endfor %}
```
```swift
let context = Context(dictionary: [
"articles": [
[ "title": "Migrating from OCUnit to XCTest", "author": "Kyle Fuller" ],
[ "title": "Memory Management with ARC", "author": "Kyle Fuller" ],
]
])
let template = Template(path:"template.stencil")
let result = template.render(context)
if let error = result.error {
println("There was a syntax error parsing your template (\(error)).")
}
println("\(result.string)")
```
## License
Stencil is licensed under the BSD license. See [LICENSE](LICENSE) for more
info.