livingsocial / rake-pipeline

An extension to Rake for dealing with a directory of inputs, a number of filters, and a directory of outputs
MIT License
276 stars 38 forks source link

Add a getting started guide and examples of common tasks #94

Closed ahawkins closed 12 years ago

ahawkins commented 12 years ago

The getting started is a user level guide. It covers creating a basic assetfile, constructing inputs and matchers, and finally writing a custom filter.

The examples cover common tasks I've encountered which have confused new users.

I've also updated the readme to point the getting started guide and examples directory. This should help the project feel more documented.

This also closes #91.

ahawkins commented 12 years ago

@lukemelia anything you think I can add or missed?

wagenet commented 12 years ago

@twinturbo I'm certain this is better than nothing. If there are errors, we can fix them later. Unfortunately, I don't have admin access as I thought. @wycats, can you merge this?