Skip to content

Commit

Permalink
README updates with links to Nuget packages
Browse files Browse the repository at this point in the history
  • Loading branch information
csainty committed Jun 28, 2014
1 parent 9a14ec0 commit d5b1bf0
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Veil

Veil is a .NET template renderer / view engine. It is designed to support many syntax parsers which sit on top of a single IL-emitting compiler.
See [Veil.SuperSimple](https://github.com/csainty/Veil/tree/master/Src/Veil.SuperSimple) and [Veil.Handlebars](https://github.com/csainty/Veil/tree/master/Src/Veil.Handlebars) for examples of syntax.
See [Veil.SuperSimple](https://github.com/csainty/Veil/tree/master/Src/Veil.SuperSimple) and [Veil.Handlebars](https://github.com/csainty/Veil/tree/master/Src/Veil.Handlebars) for examples of supported syntax.

### Design Goals

Expand All @@ -11,22 +11,20 @@ See [Veil.SuperSimple](https://github.com/csainty/Veil/tree/master/Src/Veil.Supe
* Mono support

### Not supported
Unlike Razor, Veil templates are not compiled to full .NET assemblies. This is part of what makes Veil so much easier to integrate and work with. The cost of this approach is that arbitrary code blocks are not supported.
Unlike Razor, Veil templates are not compiled with the full .NET compilers. This is part of what makes Veil so much easier to integrate and work with. The cost of this approach is that arbitrary code blocks are not supported.
A purist may argue this is actually a good thing :)


### Getting Started
Veil is available as pre-release pacakges on nuget - https://www.nuget.org/packages?q=Veil

You have two options for using Veil :-

1. If you are using [Nancy](https://github.com/NancyFx/Nancy) then install the [Nancy.ViewEngines.Veil](https://github.com/csainty/Veil/tree/master/Src/Nancy.ViewEngines.Veil) view engine and your preferred syntax e.g. [Veil.Handlebars](https://github.com/csainty/Veil/tree/master/Src/Veil.Handlebars)
2. Alternatively you can use the [VeilEngine](https://github.com/csainty/Veil/blob/master/Src/Veil/IVeilEngine.cs) directly in any application e.g.
1. If you are using [Nancy](https://github.com/NancyFx/Nancy) then install the [Nancy.ViewEngines.Veil](http://www.nuget.org/packages/Nancy.ViewEngines.Veil) package and your preferred syntax parsers e.g. [Veil.Handlebars](http://www.nuget.org/packages/Veil.Handlebars) or [Veil.SuperSimple](http://www.nuget.org/packages/Veil.SuperSimple)
2. Alternatively you can install and use any Veil syntax parser directly in any application. E.g.

````
// Installed parsers are detected from your AppDomain at startup
Install-Package Veil.Handlebars
// Compile each template once with the chosen parser
// Compile your template once with the chosen parser
var template = "Hello {{ Name }}";
var compiledTemplate = new VeilEngine().Compile<ViewModel>("handlebars", new StringReader(template));
Expand All @@ -40,7 +38,6 @@ using (var writer = new StringWriter()) {

### Build Status


Windows - [![Build Status](http://builds.nullreferenceexception.se/app/rest/builds/buildType:id:Veil_Continuos/statusIcon)](http://builds.nullreferenceexception.se/viewType.html?buildTypeId=Veil_Continuos&guest=1)

Mono - [![Build Status](http://builds.nullreferenceexception.se/app/rest/builds/buildType:id:Veil_Continuous_Mono/statusIcon)](http://builds.nullreferenceexception.se/viewType.html?buildTypeId=Veil_Continuous_Mono&guest=1)
Expand Down
8 changes: 8 additions & 0 deletions Src/Nancy.ViewEngines.Veil/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Nancy.ViewEngines.Veil

A ViewEngine for [Nancy](http://nancyfx.org/) which detects installed Veil parsers and uses them to renders views with matching extensions.

Get it on nuget `Install-Package Nancy.ViewEngines.Veil`

**Note:**
In addition to installing this package, you need to install one or more syntax parsers for Veil.

* [Veil.Handlebars](https://github.com/csainty/Veil/tree/master/Src/Veil.Handlebars)
* [Veil.SuperSimple](https://github.com/csainty/Veil/tree/master/Src/Veil.SuperSimple)
2 changes: 2 additions & 0 deletions Src/Veil.Handlebars/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A [Handlebars](http://handlebarsjs.com/) inspired syntax parser for [Veil](https://github.com/csainty/Veil).

Get it on nuget `Install-Package Veil.Handlebars`

The Handlebars parser is registered under the keys `handlebars` and `haml`.

### Syntax
Expand Down
2 changes: 2 additions & 0 deletions Src/Veil.SuperSimple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A [SuperSimpleViewEngine](https://github.com/grumpydev/SuperSimpleViewEngine) inspired syntax parser for [Veil](https://github.com/csainty/Veil).

Get it on nuget `Install-Package Veil.SuperSimple`

The SuperSimple parser is registered under the keys `supersimple`, `sshtml` and `vsshtml`.

### Syntax
Expand Down

0 comments on commit d5b1bf0

Please sign in to comment.