README.md in flutterby-0.1.0 vs README.md in flutterby-0.2.0
- old
+ new
@@ -1,41 +1,45 @@
-[](https://badge.fury.io/rb/flutterby) [](https://travis-ci.org/hmans/flutterby) 
-
# Flutterby
-#### A very good static site generator.
+### A very, very good static site generator.
+[](https://badge.fury.io/rb/flutterby) [](https://travis-ci.org/hmans/flutterby) [](https://github.com/hmans/flutterby/blob/master/LICENSE.txt) 
-### Key Features
+#### Key Features
+
- Generate a static website from a source directory!
- Apply any number of transformations on files!
- Built-in support for Markdown, Sass, Erb, Slim and more!
- Extremely easy to extend with new transformation filters!
- Sprinkle your site with Ruby code that can interact with your site's pages and data!
+#### Recommended Reading
+- [Blog post introducing Flutterby](http://hmans.io/posts/2017/01/11/flutterby.html)
+- [New project template](https://github.com/hmans/flutterby/tree/master/lib/templates/new_project) (example code)
+
## Installation & Basic Usage
Flutterby is distributed as a RubyGem, so let's install it first:
gem install flutterby
-Now let's create a new project:
+This will install a `flutterby` executable on your system. Let's use it to create a new project:
flutterby new mysite
cd mysite
-Now let's generate that static site:
+The new project template serves as a simple starting point for new projects. Let's compile it into a static site:
flutterby build
-Or run a local development server for faster development:
+Flutterby comes with a local development server that will automatically pick up changes you make to your files:
- flutterby server
+ flutterby serve
-**Note**: by default, both the `build` and `server` commands assume `./site/` to be the source directory and `./_build/` to be the export directory. Please refer to `flutterby help` to see how you can override these.
+**Note**: by default, both the `build` and `serve` commands assume `./site/` to be the source directory and `./_build/` to be the export directory. Please refer to `flutterby help` to see how you can override these.
## Examples
Please refer to the [Sites built with Flutterby](https://github.com/hmans/flutterby/wiki/Sites-built-with-Flutterby) page on the Flutterby Wiki for some examples.
@@ -44,10 +48,10 @@
## Roadmap
Flutterby is young, but already quite functional. Here's a list of changes I'm intending to make in the near future -- if you want to work on any of these, let me know!
- Performance! Right now, the source file for every node is read into RAM as a whole. Not a big problem when you're building a small site, but add some larger images, and you'll have one.
-- Change `flutterby server` so it doesn't always regenerate the _entire_ site graph when a file is modified.
+- Change `flutterby serve` so it doesn't always regenerate the _entire_ site graph when a file is modified.
- Extract filters (like Slim, Sass etc.) to separate gems, to make the core gem more light-weight.
- Improve the template site (`flutterby new`).
- Produce a fun screencast to explain what the heck is going on here!
- Write even more tests!