Skip to content

Commit 2a59ddb

Browse files
committed
Recommended usage in doc
1 parent 57aa996 commit 2a59ddb

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

lib/faster_path.rb

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,13 @@
66
require 'fiddle/import'
77

88
# FasterPath module behaves as a singleton object with the alternative method
9-
# implementations for Pathname, and some for File, available directly on it.
9+
# implementations for `Pathname`, and some for `File`, available directly on it.
1010
#
11+
# New projects are recommend to reference methods defined directly on `FasterPath`.
12+
# Existing websites may use the `FasterPath.sledgehammer_everything!` method to
13+
# directly injet the more performant implementations of path handling in to their
14+
# existing code ecosystem. To do so you will need to
15+
# `require 'faster_path/optional/monkeypatches'` beforehand.
1116
module FasterPath
1217
FFI_LIBRARY = begin
1318
toplevel_dir = File.dirname(__dir__)

0 commit comments

Comments
 (0)