aboutsummaryrefslogtreecommitdiffstats
path: root/actioncable/lib/rails/generators/channel/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'actioncable/lib/rails/generators/channel/USAGE')
-rw-r--r--actioncable/lib/rails/generators/channel/USAGE12
1 files changed, 12 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..ea9662436c
--- /dev/null
+++ b/actioncable/lib/rails/generators/channel/USAGE
@@ -0,0 +1,12 @@
+Description:
+============
+ Stubs out a new cable channel for the server (in Ruby) and client (in JavaScript).
+ Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.
+
+Example:
+========
+ rails generate channel Chat speak
+
+ creates a Chat channel class and JavaScript asset:
+ Channel: app/channels/chat_channel.rb
+ Assets: app/javascript/channels/chat_channel.js