Yaffs site version 1.1

[yaffs-website] / vendor / webflo / drupal-finder / README.md

diff --git a/vendor/webflo/drupal-finder/README.md b/vendor/webflo/drupal-finder/README.md
new file mode 100644 (file)
index 0000000..f508f91
--- /dev/null
+++ b/vendor/webflo/drupal-finder/README.md
@@ -0,0 +1,25 @@
+# Drupal Finder
+
+[![Build Status](https://travis-ci.org/webflo/drupal-finder.svg?branch=master)](https://travis-ci.org/webflo/drupal-finder)
+
+Drupal Finder provides a class to locate a Drupal installation in a given path.
+
+## Usage
+
+```
+$drupalFinder = new \DrupalFinder\DrupalFinder();
+if ($drupalFinder->locateRoot(getcwd())) {
+    $drupalRoot = $drupalFinder->getDrupalRoot();
+    $composerRoot = $drupalFinder->getComposerRoot();
+    ...
+}
+```
+
+## Examples
+
+- [Drupal Console Launcher](https://github.com/hechoendrupal/drupal-console-launcher/blob/master/bin/drupal.php)
+- [Drush Shim](https://github.com/webflo/drush-shim) (with webflo/drupal-finder:^0.0.1)
+
+## License
+
+GPL-2.0+