added generators, refactorized, prepared version 1.0

LICENSE

@@ -0,0 +1,14 @@
+# CoffeeApp - coffee-script wrapper for CouchApp
+# Copyright 2010 Andrzej Sliwa (andrzej.sliwa@i-tool.eu)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

README.markdown

@@ -20,7 +20,70 @@ Or, get the code, and `npm link` in the code root.
 
 ### Basic usage
 
-    coffeeapp [couchapp options]
+    coffeeapp [couchapp options] | [wrapped options]
+
+### Example usage
+
+
+without compilation errors:
+
+    $ coffeeapp push
+
+    CoffeeApp (v0.0.5) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
+    http://github.com/andrzejsliwa/coffeeapp
+
+    Wrapping 'push' of couchapp
+    preparing .releases/20101008202459 release...
+     * processing filters/filter.coffee...
+
+    done.
+    2010-10-08 20:25:04 [INFO] Visit your CouchApp here:
+    http://127.0.0.1:5984/tutorial/_design/hello/index.html
+
+with errors, all generated files have in content '...' which should be replaced by real code - this helps to keep clean project ;) :
+
+    $ coffeeapp push
+
+    CoffeeApp (v0.0.5) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
+    http://github.com/andrzejsliwa/coffeeapp
+
+    Wrapping 'push' of couchapp
+    preparing .releases/20101008202459 release...
+     * processing filters/filter.coffee...
+
+     * processing views/coffewview/reduce.coffee...
+    Compilation Error of .releases/20101008172605/views/myview/reduce.coffee : Parse error on line 1: Unexpected '.'
+
+    done.
+    2010-10-08 20:25:04 [INFO] Visit your CouchApp here:
+    http://127.0.0.1:5984/tutorial/_design/hello/index.html
+
+using coffee generators
+
+    $ coffeeapp cgenerate view tview
+
+    CoffeeApp (v0.0.5) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
+    http://github.com/andrzejsliwa/coffeeapp
+
+    Running CoffeeApp 'view' generator...
+     * creating myview/map.coffee...
+     * creating myview/reduce.coffee...
+    done.
+
+using help command:
+    $ coffeeapp help
+
+    ...
+    CouchApp Help here ...
+    ...
+
+    Wrapping 'help' of couchapp
+
+    CoffeeApp (v0.0.5) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
+    http://github.com/andrzejsliwa/coffeeapp
+
+    help             show this message
+    cgenerate        [ view | list | show | filter ] generate coffee-script versions of files (instead of standard 'generate')
 
 
 ### Description