README.md in bonsai-1.1.3 vs README.md in bonsai-1.1.4
- old
+ new
@@ -1,21 +1,32 @@
# bonsai
Bonsai is a static web site generator, it uses the best tools available for site construction and adheres to best web practices.
+## What it does
+
+ * Provides a tiny HTML5, mustache driven template set.
+ * Implies a simple structure to get started faster.
+ * An inbuilt server for development. No setup required.
+ * Tasks to export the site to `output`. Upload the contents of `output`. Job done.
+ * Access to page hierarchy through `children`, `siblings`, `ancestors` and `navigation`.
+ * Generates `sitemap.xml` ready for search engines to spider your site.
+ * Generates `robots.txt` to be friendly to search engines.
+
## Getting started
* Install bonsai
-
+
`gem install bonsai --source http://gemcutter.org`
-
+
* Run the generator
-
+
`bonsai --plant [NAME]`
-
+
Type `bonsai --help` for any help with commands
+
## Development server
Unlike other static generators, bonsai provides you with a built in web server. Once you've generated the necessary files (generator included) you can simply start developing. Type `bonsai --cultivate` in the root of the generated site, a web server (rack, with thin) will start up.
It will also watch for when you save files - taking care of processing your [lesscss](http://lesscss.org/) files - kind of like [autotest](http://www.zenspider.com/ZSS/Products/ZenTest/).
@@ -33,28 +44,29 @@
## Ruby implementations
Bonsai runs under a number of Ruby implementations:
+ * 1.8.6 (MRI)
* 1.8.7 (MRI)
* 1.9.1 (MRI)
* JRuby
* MacRuby
-
-## Technology used to make your site better
-
- * [Tilt](http://github.com/rtomayko/tilt) - defaulting to [Mustache](http://github.com/defunkt/mustache)
- * [Less CSS](http://lesscss.org/)
- * [YUI CSS/Javascript compressor](http://developer.yahoo.com/yui/compressor/)
## Have you used this for a real job?
Yes. I built (and content filled) a web site with around 160 pages in 5 days.
When I found something that didn't quite work, was too slow or perhaps not even possible I wrote a spec and implemented it later. Better software from real requirements. (I used every feature I implemented)
+## Links
+ * [Tilt](http://github.com/rtomayko/tilt) - defaulting to [Mustache](http://github.com/defunkt/mustache)
+ * [Less CSS](http://lesscss.org/)
+ * [YUI CSS/Javascript compressor](http://developer.yahoo.com/yui/compressor/)
+
+
## Thanks
* [Anthony Kolber](http://github.com/kolber) for writing, then rewriting [Stacey](http://github.com/kolber/stacey) from scratch. We spent many hours talking about best practice and software UX.
* [Lincoln Stoll](http://github.com/lstoll) for reminding me to use the tools that I know best
@@ -74,6 +86,6 @@
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
## Copyright
-Copyright (c) 2009 Ben Schwarz. See LICENSE for details.
+Copyright (c) 2010 Ben Schwarz. See LICENSE for details.