Permalink
Browse files

Filter list and example in readme

  • Loading branch information...
1 parent 2cfe4e7 commit ab614e9fa8e6b50aaaef3641a662d8a1d7e8ad3c twinturbo committed Oct 26, 2012
Showing with 55 additions and 8 deletions.
  1. +55 −1 README.markdown
  2. +0 −7 README.yard
View
@@ -1,4 +1,58 @@
# Rake::Pipeline::Web::Filters
-Documentation for Rake::Pipeline::Web::Filters is hosted at
+This project contains a set of rake-pipeline filters for building web
+apps.
+
+It includes these filters:
+
+* Cache Buster - Write a fingerprint into each file name
+* Coffescript - Convert Javascript to Coffeescript
+* GZip - Create gzip'd version of your files
+* Handlebars - Parse handlebars templates
+* IIFE - Wrap source files in immediately invoked functional expressions
+* Jade - Parse Jade templates
+* LESS - Convert LESS to CSS
+* Markdown - Convert Markdown to HTML
+* Minispade - Wrap JS files in Minispade modules
+* Neuter - Require files in a file and generate one single combined file
+* SASS - Convert SASS to CSS
+* Stylus - Styluss to CSS
+* Tilt - Pase Title templates
+* Uglify - Minify JS
+* YUI CSS - Minifiy CSS
+* YUI Javascript - Minify JS
+
+Here's a quick example of a realistic project's Assetfile:
+
+```ruby
+# Assetfile.rb
+require 'rake-pipeline-web-filters'
+
+output "site"
+
+input "javascripts" do
+ match "**/*.coffe" do
+ coffeescript
+ end
+
+ match "**/*.js" do
+ minispade
+ concat "application.js"
+ uglify
+ end
+end
+
+input "stylesheets" do
+ match "**/*.sass" do
+ sass
+ end
+
+ match "**/*.css" do
+ concat "application.css"
+ yui_css
+ end
+end
+```
+
+API documentation is hosted at
<a href="http://rubydoc.info/github/wycats/rake-pipeline-web-filters/master/file/README.yard">rubydoc.info</a>
View
@@ -23,10 +23,3 @@ In your +Assetfile+:
match "*.scss" do
filter Rake::Pipeline::Web::Filters::SassCompiler
end
-
-= Available Filters
-
-* {Rake::Pipeline::Web::Filters::MinispadeFilter}: Wraps JS code for use with Minispade
-* {Rake::Pipeline::Web::Filters::SassCompiler}: Compiles SCSS or Sass to CSS
-* {Rake::Pipeline::Web::Filters::TiltFilter}: Compiles templates with the Tilt template interface
-

0 comments on commit ab614e9

Please sign in to comment.