whoward/cadenza

View on GitHub
readme.md

Summary

Maintainability
Test Coverage
[![Gem Version](https://badge.fury.io/rb/cadenza.png)](http://badge.fury.io/rb/cadenza)
[![Build Status](https://secure.travis-ci.org/whoward/cadenza.png?branch=master)](http://travis-ci.org/whoward/cadenza)
[![Code Climate](https://codeclimate.com/github/whoward/cadenza.png)](https://codeclimate.com/github/whoward/cadenza)
[![Inline docs](http://inch-ci.org/github/whoward/cadenza.png)](http://inch-ci.org/github/whoward/cadenza)
[![Coverage Status](https://coveralls.io/repos/whoward/cadenza/badge.svg?branch=master)](https://coveralls.io/r/whoward/cadenza?branch=master)

# Description

Cadenza is a template parsing and rendering library for Ruby.  The syntax is very
similar to other template languages like Django (Python), Smarty (PHP), or Liquid (Ruby).

In addition to the usual template language features, Cadenza features:

- template inheritance
- extendable syntax
- interchangeable lexers, parsers, loaders and renderers

# Installation

```bash
   gem install cadenza
```

# Usage

To learn how to both write Cadenza templates and use Cadenza in your Ruby 
projects have a look at the [Cadenza Manual](http://cadenza-manual.herokuapp.com/)

To learn how to extend Cadenza with custom Lexers, Parsers, Loaders and Renderers
visit the [Yard Documentation](http://rubydoc.info/github/whoward/Cadenza/)

# Roadmap
See: [Waffle](https://waffle.io/whoward/cadenza)

If you have any ideas or suggestions please let me know! I love ideas. You can open an Issue to discuss it.

# Contributing

See: [CONTRIBUTING.md](http://github.com/whoward/cadenza/tree/master/CONTRIBUTING.md)

# Supported Ruby Versions

See: [travis.yml](http://github.com/whoward/cadenza/tree/master/.travis.yml)

# License

Cadenza is released under the MIT license