|
1 | | -# utils |
2 | | - |
3 | | -[![Latest Version on Packagist][ico-version]][link-packagist] |
4 | | -[![Software License][ico-license]](LICENSE.md) |
5 | | -[![Build Status][ico-travis]][link-travis] |
6 | | -[![Coverage Status][ico-scrutinizer]][link-scrutinizer] |
7 | | -[![Quality Score][ico-code-quality]][link-code-quality] |
8 | | -[![Total Downloads][ico-downloads]][link-downloads] |
9 | | - |
10 | | -**Note:** Replace ```Contentstack``` ```Contentstack``` ```https://www.contentstack.com``` ```support@contentstack.com``` ```contentstack``` ```utils``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line. You can run `$ php prefill.php` in the command line to make all replacements at once. Delete the file prefill.php as well. |
11 | | - |
12 | | -This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what |
13 | | -PSRs you support to avoid any confusion with users and contributors. |
14 | | - |
15 | | -## Structure |
16 | | - |
17 | | -If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following. |
18 | | - |
19 | | -``` |
20 | | -bin/ |
21 | | -build/ |
22 | | -docs/ |
23 | | -config/ |
24 | | -src/ |
25 | | -tests/ |
26 | | -vendor/ |
27 | | -``` |
28 | | - |
29 | | - |
30 | | -## Install |
31 | | - |
32 | | -Via Composer |
33 | | - |
34 | | -``` bash |
35 | | -$ composer require contentstack/utils |
36 | | -``` |
37 | | - |
38 | | -## Usage |
39 | | - |
40 | | -``` php |
41 | | -$skeleton = new League\Skeleton(); |
42 | | -echo $skeleton->echoPhrase('Hello, League!'); |
43 | | -``` |
44 | | - |
45 | | -## Change log |
46 | | - |
47 | | -Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. |
48 | | - |
49 | | -## Testing |
50 | | - |
51 | | -``` bash |
52 | | -$ composer test |
53 | | -``` |
54 | | - |
55 | | -## Contributing |
56 | | - |
57 | | -Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details. |
58 | | - |
59 | | -## Security |
60 | | - |
61 | | -If you discover any security related issues, please email support@contentstack.com instead of using the issue tracker. |
62 | | - |
63 | | -## Credits |
64 | | - |
65 | | -- [Contentstack][link-author] |
66 | | -- [All Contributors][link-contributors] |
67 | | - |
68 | | -## License |
69 | | - |
70 | | -The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
71 | | - |
72 | | -[ico-version]: https://img.shields.io/packagist/v/contentstack/utils.svg?style=flat-square |
73 | | -[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square |
74 | | -[ico-travis]: https://img.shields.io/travis/contentstack/utils/master.svg?style=flat-square |
75 | | -[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/contentstack/utils.svg?style=flat-square |
76 | | -[ico-code-quality]: https://img.shields.io/scrutinizer/g/contentstack/utils.svg?style=flat-square |
77 | | -[ico-downloads]: https://img.shields.io/packagist/dt/contentstack/utils.svg?style=flat-square |
78 | | - |
79 | | -[link-packagist]: https://packagist.org/packages/contentstack/utils |
80 | | -[link-travis]: https://travis-ci.org/contentstack/utils |
81 | | -[link-scrutinizer]: https://scrutinizer-ci.com/g/contentstack/utils/code-structure |
82 | | -[link-code-quality]: https://scrutinizer-ci.com/g/contentstack/utils |
83 | | -[link-downloads]: https://packagist.org/packages/contentstack/utils |
84 | | -[link-author]: https://github.com/Contentstack |
85 | | -[link-contributors]: ../../contributors |
86 | | -# contentstack-utils-php |
0 commit comments