|
1 | | -# PHP Package Template |
2 | | - |
3 | | -A repository template for Studio 24's open source PHP packages. |
4 | | - |
5 | | -## How to use this template |
6 | | - |
7 | | -This package can be used as to scaffold a PHP package. Follow these steps to get started: |
8 | | - |
9 | | -1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton |
10 | | -2. Run `php ./configure.php` to run a script that will replace all placeholders throughout all the files |
11 | | -3. Have fun creating your package. |
12 | | - |
13 | | -## Components |
14 | | - |
15 | | -A brief explanation of the different components of this package template. |
16 | | - |
17 | | -- `.github/ISSUE_TEMPLATE` - GitHub issue templates |
18 | | -- `.github/workflows` - GitHub actions for running tests (php.yml) and automated releases (release.yml) |
19 | | -- `.github/dependabot.yml` - Dependabot configuration |
20 | | -- `src/` - The PHP source code for your package, this will autoload based on the autoload rules in composer.json |
21 | | -- `tests` - PHPUnit tests for your package |
22 | | -- `.editorconfig` - Your [editor coding style](https://editorconfig.org/) configuration |
23 | | -- `.gitattributes` - Ignore these files/folders when this package is installed via Composer |
24 | | -- `.phpcs.xml.dist` - [PHPCodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer/) configuration |
25 | | -- `.phplint.yml` - [PHPLint](https://github.com/overtrue/phplint) configuration |
26 | | -- `CHANGELOG.md` - A list of notable changes, the contents of this file are automated by automated releases |
27 | | -- `CODE_OF_CONDUCT.md` - Contributor's code of conduct |
28 | | -- `composer.json` - Composer PHP package dependencies |
29 | | -- `configure.php` - Package configuration script, this file is deleted once run |
30 | | -- `CONTRIBUTING.md` - Guide to contributing |
31 | | -- `LICENSE.md` - License information |
32 | | -- `phpstan.neon` - [PHPStan](https://phpstan.org/) configuration |
33 | | -- `phpunit.xml.dist` - [PHPUnit](https://phpunit.de/) configuration |
34 | | -- `README.md` - This README file, this file is deleted once configure.php is run |
35 | | -- `README_DEFAULT.md` - The default README file for your new package |
36 | | -- `SECURITY.md` - Security policy for this package |
| 1 | +# This is my package accessible-forms |
| 2 | + |
| 3 | +[](https://packagist.org/packages/studio24/accessible-forms) |
| 4 | +[](https://github.com/studio24/accessible-forms/actions/workflows/php.yml) |
| 5 | + |
| 6 | +This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example. |
| 7 | + |
| 8 | +## Requirements |
| 9 | + |
| 10 | +* PHP 8.2+ |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +You can install the package via [Composer](https://getcomposer.org/): |
| 15 | + |
| 16 | +```shell |
| 17 | +composer require studio24/accessible-forms |
| 18 | +``` |
| 19 | + |
| 20 | +## Usage |
| 21 | + |
| 22 | +Include some short usage instructions here. If you need more extensive docs save these in docs/ and link to them from here. |
| 23 | + |
| 24 | +## Testing |
| 25 | + |
| 26 | +```shell |
| 27 | +composer test |
| 28 | +``` |
| 29 | + |
| 30 | +## Changelog |
| 31 | + |
| 32 | +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. |
| 33 | + |
| 34 | +## Contributing |
| 35 | + |
| 36 | +Find out more about [how to contribute](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 37 | + |
| 38 | +## Security Issues |
| 39 | + |
| 40 | +If you discover a security vulnerability within this package, please follow our [disclosure procedure](SECURITY.md). |
| 41 | + |
| 42 | +## About |
| 43 | + |
| 44 | +This package is developed by [Studio 24](https://www.studio24.net/), a human-centered digital agency who build websites and web apps that work for everyone. |
37 | 45 |
|
38 | 46 | ## License |
39 | 47 |
|
40 | 48 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
41 | | - |
42 | | -## Thanks to |
43 | | -* [Spatie Package Skeleton](https://github.com/spatie/package-skeleton-php) for inspiration on package organisation and the PHP configure script |
|
0 commit comments