|
1 | | -# php-library-starter |
2 | | - A PHP library template repository. |
| 1 | +# The Biurad PHP Library Template |
| 2 | + |
| 3 | +[](https://packagist.org/packages/biurad/php-library-starter) |
| 4 | +[](LICENSE) |
| 5 | +[](https://travis-ci.org/biurad/php-library-starter) |
| 6 | +[](https://codecov.io/gh/biurad/php-library-starter) |
| 7 | +[](https://scrutinizer-ci.com/g/biurad/php-library-starter) |
| 8 | +[](https://biurad.com/sponsor) |
| 9 | + |
| 10 | +**biurad/php-library-starter** is a template repository for biurad php library. To use this library, rename **php-library-starter** and **BSD-3** on every file that contain it to your prefered library name and license. |
| 11 | + |
| 12 | +## 📦 Installation & Basic Usage |
| 13 | + |
| 14 | +This project requires PHP 7.1 or higher. The recommended way to install, is via [Composer]. Simply run: |
| 15 | + |
| 16 | +```bash |
| 17 | +$ composer require biurad/php-library-starter |
| 18 | +``` |
| 19 | + |
| 20 | +Write a bit of **How To** use this package, so developers can have abit of idea about the repository before checking out documentation. |
| 21 | + |
| 22 | +## 📓 Documentation |
| 23 | + |
| 24 | +For in-depth documentation before using this library. Full documentation on advanced usage, configuration, and customization can be found at [docs.biurad.com][docs]. |
| 25 | + |
| 26 | +## ⏫ Upgrading |
| 27 | + |
| 28 | +Information on how to upgrade to newer versions of this library can be found in the [UPGRADE]. |
| 29 | + |
| 30 | +## 🏷️ Changelog |
| 31 | + |
| 32 | +[SemVer](http://semver.org/) is followed closely. Minor and patch releases should not introduce breaking changes to the codebase; See [CHANGELOG] for more information on what has changed recently. |
| 33 | + |
| 34 | +Any classes or methods marked `@internal` are not intended for use outside of this library and are subject to breaking changes at any time, so please avoid using them. |
| 35 | + |
| 36 | +## 🛠️ Maintenance & Support |
| 37 | + |
| 38 | +When a new **major** version is released (`1.0`, `2.0`, etc), the previous one (`0.19.x`) will receive bug fixes for _at least_ 3 months and security updates for 6 months after that new release comes out. |
| 39 | + |
| 40 | +(This policy may change in the future and exceptions may be made on a case-by-case basis.) |
| 41 | + |
| 42 | +**Professional support, including notification of new releases and security updates, is available at [Biurad Commits][commit].** |
| 43 | + |
| 44 | +## 👷♀️ Contributing |
| 45 | + |
| 46 | +To report a security vulnerability, please use the [Biurad Security](https://security.biurad.com). We will coordinate the fix and eventually commit the solution in this project. |
| 47 | + |
| 48 | +Contributions to this library are **welcome**, especially ones that: |
| 49 | + |
| 50 | +- Improve usability or flexibility without compromising our ability to adhere to ???. |
| 51 | +- Optimize performance |
| 52 | +- Fix issues with adhering to ???. |
| 53 | +- ???. |
| 54 | + |
| 55 | +Please see [CONTRIBUTING] for additional details. |
| 56 | + |
| 57 | +## 🧪 Testing |
| 58 | + |
| 59 | +```bash |
| 60 | +$ composer test |
| 61 | +``` |
| 62 | + |
| 63 | +This will tests biurad/php-library-starter will run against PHP 7.2 version or higher. |
| 64 | + |
| 65 | +## 👥 Credits & Acknowledgements |
| 66 | + |
| 67 | +- [Divine Niiquaye Ibok][@divineniiquaye] |
| 68 | +- [All Contributors][] |
| 69 | + |
| 70 | +## 🙌 Sponsors |
| 71 | + |
| 72 | +Are you interested in sponsoring development of this project? Reach out and support us on [Patreon](https://www.patreon.com/biurad) or see <https://biurad.com/sponsor> for a list of ways to contribute. |
| 73 | + |
| 74 | +## 📄 License |
| 75 | + |
| 76 | +**biurad/php-library-starter** is licensed under the BSD-3 license. See the [`LICENSE`](LICENSE) file for more details. |
| 77 | + |
| 78 | +## 🏛️ Governance |
| 79 | + |
| 80 | +This project is primarily maintained by [Divine Niiquaye Ibok][@divineniiquaye]. Members of the [Biurad Lap][] Leadership Team may occasionally assist with some of these duties. |
| 81 | + |
| 82 | +## 🗺️ Who Uses It? |
| 83 | + |
| 84 | +You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us an [email] or [message] mentioning this library. We publish all received request's at <https://patreons.biurad.com>. |
| 85 | + |
| 86 | +Check out the other cool things people are doing with `biurad/php-library-starter`: <https://packagist.org/packages/biurad/php-library-starter/dependents> |
| 87 | + |
| 88 | +[Composer]: https://getcomposer.org |
| 89 | +[@divineniiquaye]: https://github.com/divineniiquaye |
| 90 | +[docs]: https://docs.biurad.com/php-library-starter |
| 91 | +[commit]: https://commits.biurad.com/php-library-starter.git |
| 92 | +[UPGRADE]: UPGRADE-1.x.md |
| 93 | +[CHANGELOG]: CHANGELOG-0.x.md |
| 94 | +[CONTRIBUTING]: ./.github/CONTRIBUTING.md |
| 95 | +[All Contributors]: https://github.com/biurad/php-library-starter/contributors |
| 96 | +[Biurad Lap]: https://team.biurad.com |
| 97 | +[email]: support@biurad.com |
| 98 | +[message]: https://projects.biurad.com/message |
0 commit comments