Skip to content

Commit

Permalink
doc: add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Florens Verschelde committed May 29, 2017
1 parent b85aa0b commit 32d15af
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 7 deletions.
28 changes: 28 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog

## 2.0.0

BREAKING CHANGES:

- Dropped support Apache when serving in a subfolder (e.g. `http://localhost/my-twigexpress-prototype/`); use VirtualHosts, or run TwigExpress from the command line.
- Removed the `_base` global variable; if you need it, redeclare it in the `global_vars` config in `twigexpress.json`.
- Removed the `_get`, `_post` and `_cookie` global variables; use the `param()` function instead.
- The `autoescape` and `strict_variables` config keys have been moved inside a `twig_options` object; see `doc/config.md` for details.
- Removed the second parameter for the `files()` and `folders()` functions.

New features:

- Automatic Markdown previews for files ending in `.md`.
- Config: `allow_only` - whitelist of file patterns to serve.
- Config: `debug_mode` - disable folder listings, source views, debug pages.
- Twig: `param()` function for getting GET, POST and cookie values.
- Twig: create pages using the TwigExpress design (with automatic breadcrumbs), with `{% extends twigexpress_layout() %}`.

## 1.1.0

- New feature: directory listings.
- New feature: define Twig namespaces in `twigexpress.json`.

## 1.0.0

- First public release.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ TwigExpress

TwigExpress packages the [Twig templating engine][TWIG_HOME], and a few other tools, in a single file. Our goal is to make it easy to get started with Twig if you’re a designer or a front-end developer, without having to install a big PHP framework or a CMS.

*⚠ Do not use TwigExpress in production ⚠*

We recommend using TwigExpress for:

1. discovering (or play with) Twig;
2. building HTML prototypes with Twig, CSS and JS.

*Table of contents*

1. [Summary of features](#summary-of-features)
Expand Down Expand Up @@ -46,13 +53,6 @@ Installation
3. Load `http://localhost:8000/` in a web browser to browse files.<br>
Any file ending in `.twig` will be interpreted as a Twig template.

### ⚠ Do not use TwigExpress in production

We recommend using TwigExpress for:

1. discovering (or play with) Twig;
2. building HTML prototypes with Twig, CSS and JS.


Adding content
--------------
Expand Down

0 comments on commit 32d15af

Please sign in to comment.