lib/faster_path.rb in faster_path-0.3.9 vs lib/faster_path.rb in faster_path-0.3.10

@@ -4,11 +4,16 @@
 require 'faster_path/thermite_initialize'
 require 'fiddle'
 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__)
     config = Thermite::Config.new(cargo_project_path: toplevel_dir,
                                   ruby_project_path: toplevel_dir)