MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / vendor / wikimedia / relpath / README.md

diff --git a/vendor/wikimedia/relpath/README.md b/vendor/wikimedia/relpath/README.md
new file mode 100644 (file)
index 0000000..421be52
--- /dev/null
+++ b/vendor/wikimedia/relpath/README.md
@@ -0,0 +1,20 @@
+RelPath
+=======
+
+RelPath is a small PHP library for computing a relative filepath to some path,
+either from the current directory or from an optional start directory.
+
+Here is how you use it:
+
+<pre lang="php">
+$relPath = RelPath\getRelativePath( '/srv/mediawiki/resources/src/startup.js', '/srv/mediawiki' );
+// Result: string(24) "resources/src/startup.js"
+
+$fullPath = RelPath\joinPath( '/srv/mediawiki', 'resources/src/startup.js' );
+// Result: string(39) "/srv/mediawiki/resources/src/startup.js"
+</pre>
+
+License
+-------
+
+MIT