better rdoc for i18n

asanghi · Aug 16, 2014 · 587520d · 587520d
1 parent df5dca4
commit 587520d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/sidekiq/middleware/i18n.rb b/lib/sidekiq/middleware/i18n.rb
@@ -1,3 +1,9 @@
+#
+# Simple middleware to save the current locale and restore it when the job executes.
+# Use it by requiring it in your initializer:
+#
+#     require 'sidekiq/middleware/i18n'
+#
 module Sidekiq::Middleware::I18n
   # Get the current locale and store it in the message
   # to be sent to Sidekiq.