|
1 | | -# elastic-tool |
| 1 | +# Elastic-Tool 🦖 |
| 2 | + |
| 3 | + |
| 4 | +<p align="center">~ Enjoy your :coffee: ~</p> |
| 5 | + |
| 6 | +[![Minimum PHP Version `PHP >= 7.1`][ico-php-require]][link-php-site] |
| 7 | +[![Latest Stable Version][ico-version]][link-packagist] |
| 8 | +[![Total Downloads][ico-downloads]][link-downloads] |
| 9 | +[![Build Status][ico-travis]][link-travis] |
| 10 | +[![Code Coverage][ico-scrutinizer]][link-scrutinizer] |
| 11 | +[![Quality Score][ico-code-quality]][link-code-quality] |
| 12 | +[![License][ico-license]][link-license] |
| 13 | + |
| 14 | +----- |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | +## Requirements |
| 19 | +This package requires the following |
| 20 | +- php >= 7.0 |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +## Installing |
| 26 | + |
| 27 | +- **via "composer require"**: |
| 28 | + |
| 29 | + ``` shell |
| 30 | + composer require binary-cube/elastic-tool |
| 31 | + ``` |
| 32 | + |
| 33 | +- **via composer (manually)**: |
| 34 | + |
| 35 | + If you're using Composer to manage dependencies, you can include the following |
| 36 | + in your `composer.json` file: |
| 37 | +
|
| 38 | + ```json |
| 39 | + { |
| 40 | + "require": { |
| 41 | + "binary-cube/elastic-tool": "0.*" |
| 42 | + } |
| 43 | + } |
| 44 | + ``` |
| 45 | +
|
| 46 | +## Example of usage |
| 47 | +```php |
| 48 | +// TODO: Add |
| 49 | +``` |
| 50 | +
|
| 51 | +
|
| 52 | +## Bugs and feature requests |
| 53 | +
|
| 54 | +Have a bug or a feature request? |
| 55 | +Please first read the issue guidelines and search for existing and closed issues. |
| 56 | +If your problem or idea is not addressed yet, [please open a new issue][link-new-issue]. |
| 57 | +
|
| 58 | +
|
| 59 | +
|
| 60 | +
|
| 61 | +## Contributing guidelines |
| 62 | +
|
| 63 | +All contributions are more than welcomed. |
| 64 | +Contributions may close an issue, fix a bug (reported or not reported), add new design blocks, |
| 65 | +improve the existing code, add new feature, and so on. |
| 66 | +In the interest of fostering an open and welcoming environment, |
| 67 | +we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, |
| 68 | +regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, |
| 69 | +personal appearance, race, religion, or sexual identity and orientation. |
| 70 | +[Read the full Code of Conduct][link-code-of-conduct]. |
| 71 | +
|
| 72 | +
|
| 73 | +
|
| 74 | +
|
| 75 | +#### Versioning |
| 76 | +
|
| 77 | +Through the development of new versions, we're going use the [Semantic Versioning][link-semver]. |
| 78 | + |
| 79 | +Example: `1.0.0`. |
| 80 | +- Major release: increment the first digit and reset middle and last digits to zero. Introduces major changes that might break backward compatibility. E.g. 2.0.0 |
| 81 | +- Minor release: increment the middle digit and reset last digit to zero. It would fix bugs and also add new features without breaking backward compatibility. E.g. 1.1.0 |
| 82 | +- Patch release: increment the third digit. It would fix bugs and keep backward compatibility. E.g. 1.0.1 |
| 83 | + |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +## Authors |
| 88 | + |
| 89 | +* **Banciu N. Cristian Mihai** |
| 90 | + |
| 91 | +See also the list of [contributors][link-contributors] who participated in this project. |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | + |
| 96 | +## License |
| 97 | + |
| 98 | +This project is licensed under the MIT License - see the [LICENSE][link-license] file for details. |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | + |
| 103 | +<!-- Links --> |
| 104 | +[ico-php-require]: https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg?style=flat-square |
| 105 | +[ico-version]: https://img.shields.io/packagist/v/binary-cube/elastic-tool.svg?style=flat-square |
| 106 | +[ico-downloads]: https://img.shields.io/packagist/dt/binary-cube/elastic-tool.svg?style=flat-square |
| 107 | +[ico-travis]: https://img.shields.io/travis/binary-cube/elastic-tool/master.svg?style=flat-square |
| 108 | +[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/binary-cube/elastic-tool.svg?style=flat-square |
| 109 | +[ico-code-quality]: https://img.shields.io/scrutinizer/g/binary-cube/elastic-tool.svg?style=flat-square |
| 110 | +[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square |
| 111 | + |
| 112 | +[link-domain]: https://binary-cube.com |
| 113 | +[link-homepage]: https://binary-cube.com |
| 114 | +[link-git-source]: https://github.com/binary-cube/elastic-tool |
| 115 | +[link-packagist]: https://packagist.org/packages/binary-cube/elastic-tool |
| 116 | +[link-downloads]: https://packagist.org/packages/binary-cube/elastic-tool |
| 117 | +[link-php-site]: https://php.net |
| 118 | +[link-semver]: https://semver.org |
| 119 | +[link-code-of-conduct]: https://github.com/binary-cube/elastic-tool/blob/master/code-of-conduct.md |
| 120 | +[link-license]: https://github.com/binary-cube/elastic-tool/blob/master/LICENSE |
| 121 | +[link-contributors]: https://github.com/binary-cube/elastic-tool/graphs/contributors |
| 122 | +[link-new-issue]: https://github.com/binary-cube/elastic-tool/issues/new |
| 123 | +[link-travis]: https://travis-ci.org/binary-cube/elastic-tool |
| 124 | +[link-scrutinizer]: https://scrutinizer-ci.com/g/binary-cube/elastic-tool/code-structure |
| 125 | +[link-code-quality]: https://scrutinizer-ci.com/g/binary-cube/elastic-tool |
| 126 | +[link-enqueue]: https://github.com/php-enqueue |
0 commit comments