Update license information
[keruald.git] / omnitools / README.md
blob084cf63077c360bc6e914e7e38f28849fb625441
1 # Keruald OmniTools library
3 This utilities library offers convenient functions to solve common problems,
4 like parse an URL, generate a random string or validate an IP address.
6 ## Getting started
8 ### With Composer 
10 To use this library in a project, you can require the following package: 
12 ```
13 $ composer require keruald/omnitools
14 ```
16 ### As a bundle
18 The library follows PSR-4 conventions:
19 the `src` folder matches the `Keruald\OmniTools` namespace.
21 If you don't have a PSR-4 loader available:
23 ```lang=php
24 <?php
26 use Keruald\OmniTools\Registration\Autoloader; 
28 require 'path/to/keruald/omnitools/src/Registration/Autoloader.php';
29 Autoloader::selfRegister();
30 ```
32 ## Contribute or report issues
34 The Nasqueron DevCentral Phabricator instance is used to coordinate
35 development. You can fill issues against the #Keruald project.
37 https://devcentral.nasqueron.org/u/keruald
39 ## Versioning
41 The library is sorted in namespaces and contains mostly static methods.
43 The library adheres to semantic versioning.
44 The 0.* version will be used to integrate code from the sourcing projects,
45 like Keruald/Pluton, Keruald/Xen, Azhàr or Zed.
47 ## Credits
49 This library is maintained by Sébastien Santoro aka Dereckson.
51 The Contributors file contains the list of the people who contributed
52 to the source code.
54 ## License
56 This code is available under BSD-2-Clause license.