Recommended usage in doc

danielpclark · Mar 14, 2018 · 2a59ddb · 2a59ddb
1 parent 57aa996
commit 2a59ddb
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/lib/faster_path.rb b/lib/faster_path.rb
@@ -6,8 +6,13 @@
 require 'fiddle/import'
 
 # FasterPath module behaves as a singleton object with the alternative method
-# implementations for Pathname, and some for File, available directly on it.
+# implementations for `Pathname`, and some for `File`, available directly on it.
 #
+# New projects are recommend to reference methods defined directly on `FasterPath`.
+# Existing websites may use the `FasterPath.sledgehammer_everything!` method to
+# directly injet the more performant implementations of path handling in to their
+# existing code ecosystem.  To do so you will need to
+# `require 'faster_path/optional/monkeypatches'` beforehand.
 module FasterPath
   FFI_LIBRARY = begin
     toplevel_dir = File.dirname(__dir__)