README.md in middleman-scaffold-0.0.0.1 vs README.md in middleman-scaffold-0.0.0.2
- old
+ new
@@ -1,27 +1,42 @@
-# Middleman::Scaffold
+# Middleman-Scaffold [](http://badge.fury.io/rb/middleman-scaffold)
-`middleman-scaffold` is an extension for the [Middleman] static site generator that adds support for Slim, Sass, Coffeescript, Live-reload.
+`middleman-scaffold` is an extension for the `Middleman` static site generator that adds support for `slim`, `sass`, `coffee-script`. and its Gemfile includes live-reload, deploy modules.
## Installation
-Add this line to your application's Gemfile:
+You will have access to the middleman command with generating scaffold. From the terminal:
$ gem install middleman
$ gem install middleman-scaffold
$ middleman init MY_PROJECT --template scaffold
-If you already have a Middleman project: Add `gem "middleman-scaffold"` to your `Gemfile` and run `bundle install`
-
And then execute:
$ cd MY_PROJECT
$ bundle install --path vendor/bundle
+## Template file
+
+ └── source
+ ├── css
+ │ └── all.css.sass
+ │ └── reset.css.sass
+ ├── img
+ ├── js
+ │ └── all.js.coffee
+ └── layouts
+ │ ├── layout.slim
+ │ ├── _footer.slim
+ │ └── _header.slim
+ └────── index.html.slim
+
## Usage
# run local server
$ bundle exec middleman server
+
# build html
$ bundle exec middleman build
+
# deploy build html
$ bundle exec middleman deploy