README.md in rail-0.0.5 vs README.md in rail-0.0.6
- old
+ new
@@ -1,25 +1,23 @@
# Rail [](http://badge.fury.io/rb/rail) [](https://gemnasium.com/IvanUkhov/rail) [](https://travis-ci.org/IvanUkhov/rail)
A light framework for front-end development inspired by
-[Rails](http://rubyonrails.org/). It is solely based on
-[Sprockets](https://github.com/sstephenson/sprockets) and includes the
-following components out of the box:
+[Rails](http://rubyonrails.org/). The sole purpose of Rail is to compile
+assets, and it includes the following components:
* [CoffeeScript](http://coffeescript.org/) for JavaScript,
-* [Haml](http://haml.info/) for HTML,
-* [Sass](http://sass-lang.com/) for CSS, and
-* [Uglifier](https://github.com/lautis/uglifier) for compression.
+* [Haml](http://haml.info/) for HTML, and
+* [Sass](http://sass-lang.com/) for CSS.
## Installation
First of all, include the gem in your `Gemfile`. Here is an example:
```ruby
source 'https://rubygems.org'
-gem 'rail', '~> 0.0.5'
+gem 'rail', '~> 0.0.6'
# The rest is optional
gem 'redcarpet', '~> 3.1.2' # your favorit complement to Haml
gem 'thin', '~> 1.6.2' # your favorit Web server
```
@@ -73,12 +71,17 @@
* `app/assets/stylesheets` for styles,
* `app/views` for templates,
* `app/helpers` for helper modules, and
* `public` for other static content.
-In addition, `app/views/layouts/application.html.haml` will be used for
-rendering the root of your application (both `/` and `/index.html`).
+The templates in `app/views/layouts` have a special purpose. First,
+`application.html.haml` is used for rendering the root of your application
+(both `/` and `/index.html`). Second, any template in `layouts` is used as
+a layout for the templates in the subfolder of `views` that has the same name
+as the layout. For example, `articles/what-is-the-meaning-of-life.html.haml`
+will be rendered in the context of `layouts/articles.html.haml` provided
+that the latter has a placeholder for the former via the `yield` keyword.
### Configuration
As with Rails, Rail is configured inside `config/application.rb`:
@@ -122,10 +125,10 @@
delete the precompiled files when you change your code in `app`.
### Examples
Additional usage examples can be found
-[here](https://github.com/IvanUkhov/type-works),
+[here](https://github.com/IvanUkhov/opentype-works),
[here](https://github.com/IvanUkhov/photography), and
[here](https://github.com/IvanUkhov/liu-profile).
## Contributing