Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Added decent README

  • Loading branch information...
commit 5260792db090511fa35f9d983a49882ee6625cd8 1 parent fc5e557
Jonas Nicklas authored January 03, 2010

Showing 1 changed file with 34 additions and 14 deletions. Show diff stats Hide diff stats

  1. 48  README.rdoc
48  README.rdoc
Source Rendered
... ...
@@ -1,32 +1,52 @@
1  
-= bistro_car
  1
+= BistroCar
2 2
 
3  
-* http://github.com/#{github_username}/#{project_name}
  3
+* http://github.com/jnicklas/bistro_car
4 4
 
5  
-== DESCRIPTION:
  5
+== Description:
6 6
 
7  
-FIX (describe your package)
  7
+BistroCar serves up {CoffeeScript}[http://jashkenas.github.com/coffee-script/]
  8
+from within your Rails application.
8 9
 
9  
-== FEATURES/PROBLEMS:
  10
+== Install:
10 11
 
11  
-* FIX (list of features or problems)
  12
+Add it as a gem dependency to you Rails application:
12 13
 
13  
-== SYNOPSIS:
  14
+    config.gem "bistro_car"
14 15
 
15  
-  FIX (code sample of usage)
  16
+== Usage:
16 17
 
17  
-== REQUIREMENTS:
  18
+Add your CoffeeScript files to <tt>app/scripts</tt>. Then in your layout or wherever else suits you, add:
18 19
 
19  
-* FIX (list of requirements)
  20
+    <%= coffee_script_bundle %>
20 21
 
21  
-== INSTALL:
  22
+This will insert automatically link to your JavaScriptified CoffeeScript files. You might find it useful, for debugging purposes, to render your CoffeeScript inline, instead of linking to external scripts, you can do that with:
22 23
 
23  
-* FIX (sudo gem install, anything else)
  24
+    <%= coffee_script_bundle :mode => :inline %>
24 25
 
25  
-== LICENSE:
  26
+You can set this for the entire application:
  27
+
  28
+    BistroCar.mode = :inline
  29
+
  30
+== Secondary bundles:
  31
+
  32
+You're encouraged to create only a single bundle, but sometimes you might find it useful/necessary to create multiple bundles for different parts of your application. In that case you can create a directory structure like this:
  33
+
  34
+    + app
  35
+      + scripts
  36
+        + admin
  37
+          - admin.coffee
  38
+          - other_admin.coffee
  39
+        - application.coffee
  40
+
  41
+Now you can require both bundles like this:
  42
+
  43
+    <%= coffee_script_bundle :admin %>
  44
+
  45
+== License:
26 46
 
27 47
 (The MIT License)
28 48
 
29  
-Copyright (c) 2010 FIXME full name
  49
+Copyright (c) 2010 Jonas Nicklas
30 50
 
31 51
 Permission is hereby granted, free of charge, to any person obtaining
32 52
 a copy of this software and associated documentation files (the

0 notes on commit 5260792

Please sign in to comment.
Something went wrong with that request. Please try again.