Skip to content

Commit

Permalink
feat: initial_pkg_configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
thuhtettun-geniefintech committed Jul 13, 2022
1 parent df58688 commit b0d1f58
Show file tree
Hide file tree
Showing 21 changed files with 82 additions and 386 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
url: https://github.com/spatie/weight-conversion/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
url: https://github.com/spatie/weight-conversion/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/:vendor_name/:package_name/security/policy
url: https://github.com/spatie/weight-conversion/security/policy
about: Learn how to notify us for sensitive bugs
- name: Report a bug
url: https://github.com/:vendor_name/:package_name/issues/new
url: https://github.com/spatie/weight-conversion/issues/new
about: Report a reproducable bug
12 changes: 0 additions & 12 deletions .github/dependabot.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/dependabot-auto-merge.yml

This file was deleted.

2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `weight-conversion` will be documented in this file.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) :vendor_name <author@domain.com>
Copyright (c) spatie <thuhtettun@geniefintech.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
41 changes: 16 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,18 @@

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)

# :package_description

[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/run-tests?label=tests)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
<!--delete-->
---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
---
<!--/delete-->
# Weight Conversion in PHP

[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/weight-conversion.svg?style=flat-square)](https://packagist.org/packages/spatie/weight-conversion)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/spatie/weight-conversion/run-tests?label=tests)](https://github.com/spatie/weight-conversion/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/spatie/weight-conversion/Check%20&%20fix%20styling?label=code%20style)](https://github.com/spatie/weight-conversion/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/weight-conversion.svg?style=flat-square)](https://packagist.org/packages/spatie/weight-conversion)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Support us

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/weight-conversion.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/weight-conversion)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

Expand All @@ -32,20 +23,20 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
You can install the package via composer:

```bash
composer require :vendor_slug/:package_slug
composer require spatie/weight-conversion
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan vendor:publish --tag="weight-conversion-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag=":package_slug-config"
php artisan vendor:publish --tag="weight-conversion-config"
```

This is the contents of the published config file:
Expand All @@ -58,14 +49,14 @@ return [
Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag=":package_slug-views"
php artisan vendor:publish --tag="weight-conversion-views"
```

## Usage

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
$weightConversion = new Spatie\WeightConversion();
echo $weightConversion->echoPhrase('Hello, Spatie!');
```

## Testing
Expand All @@ -80,15 +71,15 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re

## Contributing

Please see [CONTRIBUTING](https://github.com/:author_username/.github/blob/main/CONTRIBUTING.md) for details.
Please see [CONTRIBUTING](https://github.com/thuhtettun-geniefintech/.github/blob/main/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [:author_name](https://github.com/:author_username)
- [Thu Htet Tun](https://github.com/thuhtettun-geniefintech)
- [All Contributors](../../contributors)

## License
Expand Down
29 changes: 14 additions & 15 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "spatie/weight-conversion",
"description": "Weight Conversion in PHP",
"keywords": [
":vendor_name",
"spatie",
"laravel",
":package_slug"
"weight-conversion"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/spatie/weight-conversion",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Thu Htet Tun",
"email": "thuhtettun@geniefintech.com",
"role": "Developer"
}
],
Expand All @@ -30,18 +30,17 @@
"phpstan/extension-installer": "^1.1",
"phpstan/phpstan-deprecation-rules": "^1.0",
"phpstan/phpstan-phpunit": "^1.0",
"phpunit/phpunit": "^9.5",
"spatie/laravel-ray": "^1.26"
"phpunit/phpunit": "^9.5"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
"Spatie\\WeightConversion\\": "src",
"Spatie\\WeightConversion\\Database\\Factories\\": "database/factories"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests"
"Spatie\\WeightConversion\\Tests\\": "tests"
}
},
"scripts": {
Expand All @@ -56,13 +55,13 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Spatie\\WeightConversion\\WeightConversionServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"WeightConversion": "Spatie\\WeightConversion\\Facades\\WeightConversion"
}
}
},
"minimum-stability": "dev",
"prefer-stable": true
}
}
5 changes: 0 additions & 5 deletions config/skeleton.php

This file was deleted.

5 changes: 5 additions & 0 deletions config/weight-conversion.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?php
// config for Spatie/WeightConversion
return [

];
Loading

0 comments on commit b0d1f58

Please sign in to comment.