README.md in middleman-tansu-0.0.3 vs README.md in middleman-tansu-0.0.4

- old
+ new

@@ -1,30 +1,52 @@ # Middleman::Tansu [![Gem Version](https://badge.fury.io/rb/middleman-tansu.svg)](http://badge.fury.io/rb/middleman-tansu) [![Build Status](https://travis-ci.org/yterajima/middleman-tansu.svg?branch=develop)](https://travis-ci.org/yterajima/middleman-tansu) -TODO: Write a gem description +A template of Middleman to manage Markdown files efficiently. ## Installation -Add this line to your application's Gemfile: - ```ruby gem 'middleman-tansu' ``` And then execute: - $ bundle +``` +$ bundle + # or +$ bundle install --path vendor/bundle # better way +``` Or install it yourself as: - $ gem install middleman-tansu +``` +$ gem install middleman-tansu +``` ## Usage -TODO: Write usage instructions here +middleman-tansu is a template of Middleman. This template contain some extensions. + +``` +$ middleman init PROJECT --template tansu +``` + +This template(& extensions) has `tansu` command. You can create Markdown file. + +``` +$ bundle exec middleman tansu path/to/page_name +``` + +Then `source/path/to/page_name.html.md` that contain Frontmatter was created. Please start server and acces to `http://localhost:4567` + +``` +$ bundle exec middleman server +``` + +You could see directories and pages just below the `source/templates/index.html.slim`. This index page under EMPTY folders is automatically generated. When `source/templates/index.html.slim` is edited, you can change design and functionality of these index pages. ## Contributing 1. Fork it ( https://github.com/[my-github-username]/middleman-tansu/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)