From 3090a07a297d52751e24e351faeddbf7859ad07d Mon Sep 17 00:00:00 2001 From: Hayden Pierce Date: Sat, 28 Jul 2018 14:42:35 -0500 Subject: [PATCH] Add readme --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d5c78f3 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +ClassFinder +=========== + +A lightweight utility to identify classes in a given namespace. This package is an improved implementation of an + [answer on Stack Overflow](https://stackoverflow.com/a/40229665/3000068) that provides additional features with less + configuration required. + +Requirements +------------ + + * Application is using Composer. + * Classes are compliant with PSR-4. + * PHP >= 5.3.0 + +Installing +---------- + +Installing is done by requiring it with Composer. + +``` +$ composer require haydenpierce/class-finder +``` + +No other installation methods are currently supported. + +Example +------- + +``` +