From 2a59ddbfeaf941e3919f6be1c9e6530fe67102b6 Mon Sep 17 00:00:00 2001 From: "Daniel P. Clark" <6ftdan@gmail.com> Date: Wed, 14 Mar 2018 16:15:54 -0400 Subject: [PATCH] Recommended usage in doc --- lib/faster_path.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/faster_path.rb b/lib/faster_path.rb index c24cb08..3c0f40c 100644 --- 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__)