aboutsummaryrefslogtreecommitdiffstats
path: root/actioncable/lib/rails/generators/channel/USAGE
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2015-12-15 21:38:58 +0100
committerDavid Heinemeier Hansson <david@loudthinking.com>2015-12-15 21:39:22 +0100
commit40cc72548f529fbe3a52577dca3d0517f631f1b5 (patch)
tree2828aed91c7c04df439089ad309df6f8dc394ba1 /actioncable/lib/rails/generators/channel/USAGE
parent649b9d93219b5b38bb2fccba5124c4e013726d9e (diff)
downloadrails-40cc72548f529fbe3a52577dca3d0517f631f1b5.tar.gz
rails-40cc72548f529fbe3a52577dca3d0517f631f1b5.tar.bz2
rails-40cc72548f529fbe3a52577dca3d0517f631f1b5.zip
Basic channel generator
Diffstat (limited to 'actioncable/lib/rails/generators/channel/USAGE')
-rw-r--r--actioncable/lib/rails/generators/channel/USAGE14
1 files changed, 14 insertions, 0 deletions
diff --git a/actioncable/lib/rails/generators/channel/USAGE b/actioncable/lib/rails/generators/channel/USAGE
new file mode 100644
index 0000000000..c061196d43
--- /dev/null
+++ b/actioncable/lib/rails/generators/channel/USAGE
@@ -0,0 +1,14 @@
+Description:
+============
+ Stubs out a new cable channel and its CoffeeScript assets. Passes the chanel name, either
+ CamelCased or under_scored, and an optional list of channel actions as arguments.
+
+ This generates a channel class in app/channels.
+
+Example:
+========
+ rails generate channel Chat speak
+
+ creates a Chat channel class and CoffeeScript asset:
+ Channel: app/channels/chat_channel.rb
+ Assets: app/assets/javascript/channels/chat.coffee