Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update LICENSE and README

  • Loading branch information...
commit 7a8a38dc908b3424db42032a0fb4e75f102437f5 1 parent 5c60617
@pvorb authored
Showing with 37 additions and 19 deletions.
  1. +1 −1  LICENSE.mkd → LICENSE
  2. +36 −18 README.mkd
View
2  LICENSE.mkd → LICENSE
@@ -1,4 +1,4 @@
-Copyright © 2011 Paul Vorbach <paul@vorb.de>
+Copyright © 2011-2012 Paul Vorbach <paul@vorb.de> (http://vorb.de)
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
View
54 README.mkd
@@ -1,13 +1,19 @@
-**bake** is a mighty template engine for static text files. It is something like
+# bake
+
+a template engine for static text files. It is something like
[Tom Preston-Werner][mojombo]'s [jekyll][jekyll], but is independent of file
types and markup languages.
-**bake** enables JavaScript templates for any type of text files. These
-templates may contain [embedded JavaScript][ejs] as a template language.
+bake allows you to apply JavaScript templates to any type of text files. These
+templates are written in [embedded JavaScript][ejs].
+
+## Installation
+```
+npm install bake
+```
-Example
-=======
+## Usage
A template (`default.tpl`) may look like this:
@@ -23,7 +29,7 @@ A template (`default.tpl`) may look like this:
<%= __content %>
-<% if (has('foo')) { %>
+<% if (locals.foo) { %>
<p>Foo is defined.</p>
<% } %>
@@ -81,8 +87,7 @@ output.
Visit the [Wiki][wiki] for more information or look at the [example][example].
-What this is not
-================
+## What this is not
**bake** is not a webserver. It doesn't replace your Apache/Nginx etc. So if you
want to write a website that is accessible by the public, you have to change the
@@ -94,21 +99,13 @@ have any commenting functionality either. If you are looking for a system with
these features, try [bread][bread] which is based on **bake**.
-Bugs and Issues
-===============
+## Bugs and Issues
If you encounter any bugs or issues, feel free to open an issue at
[github][issues].
-License
-=======
-
-This package is licensed under the [MIT license][mit].
-
-
-Credits
-=======
+## Credits
This work was inspired by [heimweh][heimweh] by [Benjamin Birkenhake][ben_] and
[txtracer][txtracer] by [Konstantin Weiss][konnexus], but also by
@@ -132,3 +129,24 @@ Preston-Werner][mojombo].
[wheat]: //github.com/creationix/wheat
[creationix]: //github.com/creationix
[mojombo]: http://tom.preston-werner.com/
+
+## License
+
+Copyright © 2011-2012 Paul Vorbach
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please sign in to comment.
Something went wrong with that request. Please try again.