README.md in markd-0.1.1 vs README.md in markd-0.1.2
- old
+ new
@@ -1,29 +1,52 @@
markd
===========================
-markd is rich html builder for markdown.
+markd is rich html builder for markdown, and is especially focused on printing purpose.
+You can get well-formatted printings (or PDF by preview) when you print html using modern browser (such as Google Chrome, Firefox, Safari).
+
markd is based on [bluecloth][1] and [google code prittify][2].
+features:
+
+ - Well-formatted HTML with CSS
+ - Good style for printings
+ - Auto numbered chapters
+ - Code Highlighting
+
[1]: http://deveiate.org/projects/BlueCloth
[2]: http://code.google.com/p/google-code-prettify/
## Installation
You can install markd using RubyGems as below:
- gem install markd
+ $ gem install markd
+
## Usage
-If you are going to build html file from markdown.md, you should type next command.
- markd -o out_dir markdown.md
-html and some css/js files will be generated in out_dir folder.
+Build html from markdown:
+ $ markd -o out_dir markdown.md
+where *markdown.md* is target markdown file and *out_dir* is directory
+that html/css/js files are generated into.
-## Copyright
+Use -h (or --help) option to show detail.
-Copyright (c) 2011 [daisuke sugimori][3] ([@daixque][4]). See LICENSE.txt for
-further details.
+ $ markd -h
-[3]: http://blognewart.blogspot.com/
-[4]: http://twitter.com/daixque
+## Instructions
+See more instructions:
+
+ - [my blog post (in Japanese)][3]
+
+[3]: http://opentechnica.blogspot.com/2011/08/markd.html
+
+## License
+markd is released under the MIT license.
+
+## Copyright
+Copyright (c) 2011 [daisuke sugimori][4] ([@daixque][5]).
+
+[4]: http://blognewart.blogspot.com/
+[5]: http://twitter.com/daixque