Skip to content
Browse files

+ doc

  • Loading branch information...
1 parent 545950e commit e2d231e7c9a1a96a78c1635782427e6715ddb0dd @floere committed Feb 3, 2011
Showing with 22 additions and 3 deletions.
  1. +22 −3 lib/suckerfish.rb
View
25 lib/suckerfish.rb
@@ -1,6 +1,25 @@
-# This is a simple interface that provides the user of
-# with the possibility to change parameters or call methods
-# in the master while the application is running.
+# Suckerfish allows you to pass simple parameters
+# through to the master process in Unicorn.
+#
+# Usage:
+# # On initialization.
+# # As an example, some object(s) we want to call methods on.
+# #
+# configuration = Configuration.new
+# #
+# # The configuration instance is captured in the block.
+# #
+# suckerfish = Suckerfish.in_master do |name|
+# configuration.greet name
+# end
+#
+# # In the child process, e.g. in the controller where you
+# # receive a request, you can call
+# # #call_master_with(same, parameters, as_in_the, in_master_block, above)
+# #
+# # Note: You can only pass to_s/eval de-/serializable objects.
+# #
+# suckerfish.call_master_with "Florian"
#
# Important Note:
# This will only work in Master/Child configurations.

0 comments on commit e2d231e

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