Skip to content

Commit 739dfd7

Browse files
committed
Create README.md
1 parent 5179b31 commit 739dfd7

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# :package_name
2+
3+
:package_description
4+
5+
## Installation
6+
7+
You can install the package via composer:
8+
9+
```bash
10+
composer require :vendor_slug/:package_slug
11+
```
12+
13+
## Usage
14+
15+
```php
16+
use :vendor_namespace\:package_class_name\:package_class_name;
17+
18+
$packageDetail = (new :package_class_name)->getPackageDetail();
19+
20+
var_dump($packageDetail);
21+
```
22+
23+
## Testing
24+
25+
```bash
26+
composer test
27+
```
28+
29+
## Changelog
30+
31+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
32+
33+
## Contributing
34+
35+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
36+
37+
## Security
38+
39+
If you discover any security related issues, please email `:author_email` instead of using the issue tracker.
40+
41+
## Credits
42+
43+
- [:author_name](https://github.com/:author_username)
44+
- [All Contributors](https://github.com/:vendor_slug/:package_slug/graphs/contributors)
45+
46+
## License
47+
48+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)