diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +Keruald OmniTools library + +This utilities library offers convenient function to solve common problems, +like parse an URL, generate a random string or validate an IP address. + +The library is sorted in namespaces and contains mostly static methods. + +The library adheres to semantic versioning. + +## Getting started + +### With Composer + + +To use this library in a project, you can require the following package: + +``` +$ composer require keruald/omnitools +``` + +### As a bundle + +The library follows PSR-4 conventions: +the `src` folder matches the `Keruald\OmniTools` namespace. + +If you don't have a PSR-4 loader available: + +```lang=php +