From 5fd46d26474c2c8ecf98bf1c99168c5246025e0f Mon Sep 17 00:00:00 2001 From: freek Date: Thu, 22 Apr 2021 16:27:29 +0200 Subject: [PATCH] configure skeleton --- .github/FUNDING.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 6 +- .github/SECURITY.md | 2 +- CHANGELOG.md | 2 +- LICENSE.md | 2 +- README.md | 28 +++--- composer.json | 18 ++-- configure-skeleton.sh | 136 ------------------------------ src/ForkClass.php | 7 ++ src/SkeletonClass.php | 7 -- tests/ExampleTest.php | 2 +- 11 files changed, 38 insertions(+), 174 deletions(-) delete mode 100755 configure-skeleton.sh create mode 100644 src/ForkClass.php delete mode 100755 src/SkeletonClass.php diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index a1d9b18..ec5d24c 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1,2 @@ -github: :vendor_name +github: spatie custom: :author_homepage diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index aeef948..bd624ae 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ 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/fork/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/fork/discussions/new?category=ideas about: Share ideas for new features - name: Report a bug - url: https://github.com/:vendor_name/:package_name/issues/new + url: https://github.com/spatie/fork/issues/new about: Report a reproducable bug diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 12ab7c2..ca91343 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -1,3 +1,3 @@ # Security Policy -If you discover any security related issues, please email author@domain.com instead of using the issue tracker. +If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker. diff --git a/CHANGELOG.md b/CHANGELOG.md index 767365d..aa6d6a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -All notable changes to `:package_name` will be documented in this file. +All notable changes to `fork` will be documented in this file. ## 1.0.0 - 202X-XX-XX diff --git a/LICENSE.md b/LICENSE.md index 58c9ad4..cfe1413 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) :vendor_name +Copyright (c) spatie Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 096c0ac..e265dda 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ -# :package_description +# A lightweight solution for running code concurrently in PHP -[![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%3ATests+branch%3Amaster) -[![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%3Amaster) -[![Total Downloads](https://img.shields.io/packagist/dt/vendor_slug/package_slug.svg?style=flat-square)](https://packagist.org/packages/vendor_slug/package_slug) +[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/fork.svg?style=flat-square)](https://packagist.org/packages/spatie/fork) +[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/spatie/fork/run-tests?label=tests)](https://github.com/spatie/fork/actions?query=workflow%3ATests+branch%3Amaster) +[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/spatie/fork/Check%20&%20fix%20styling?label=code%20style)](https://github.com/spatie/fork/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amaster) +[![Total Downloads](https://img.shields.io/packagist/dt/spatie/fork.svg?style=flat-square)](https://packagist.org/packages/spatie/fork) -[](delete) 1) manually replace `:author_name, :author_username, auhor@domain.com, :vendor_name, vendor_slug, Vendor Name, :package_name, package_slug, skeleton, Skeleton, :package_description` with their correct values -[](delete) in `CHANGELOG.md LICENSE.md README.md composer.json SkeletonClass.php ExampleTest.php FUNDING.yml config.yml SECURITY.md` -[](delete) and delete `configure-skeleton.sh` +[](delete) 1) manually replace `Freek Van der Herten, freekmurze, auhor@domain.com, spatie, spatie, Vendor Name, fork, fork, fork, Fork, A lightweight solution for running code concurrently in PHP` with their correct values +[](delete) in `CHANGELOG.md LICENSE.md README.md composer.json ForkClass.php ExampleTest.php FUNDING.yml config.yml SECURITY.md` +[](delete) and delete `configure-fork.sh` -[](delete) 2) You can also run `./configure-skeleton.sh` to do this automatically. +[](delete) 2) You can also run `./configure-fork.sh` to do this automatically. This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example. ## Support us -[](https://spatie.be/github-ad-click/package-skeleton-php) +[](https://spatie.be/github-ad-click/package-fork-php) 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). @@ -26,14 +26,14 @@ 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/fork ``` ## Usage ```php -$skeleton = new VendorName\Skeleton(); -echo $skeleton->echoPhrase('Hello, VendorName!'); +$fork = new Spatie\Fork(); +echo $fork->echoPhrase('Hello, Spatie!'); ``` ## Testing @@ -56,7 +56,7 @@ Please review [our security policy](../../security/policy) on how to report secu ## Credits -- [:author_name](https://github.com/:author_username) +- [Freek Van der Herten](https://github.com/freekmurze) - [All Contributors](../../contributors) ## License diff --git a/composer.json b/composer.json index b98166c..0389e0c 100644 --- a/composer.json +++ b/composer.json @@ -1,16 +1,16 @@ { - "name": "vendor_slug/package_slug", - "description": ":package_description", + "name": "spatie/fork", + "description": "A lightweight solution for running code concurrently in PHP", "keywords": [ - ":vendor_name", - "package_slug" + "spatie", + "fork" ], - "homepage": "https://github.com/vendor_slug/package_slug", + "homepage": "https://github.com/spatie/fork", "license": "MIT", "authors": [ { - "name": ":author_name", - "email": "author@domain.com", + "name": "Freek Van der Herten", + "email": "freek@spatie.be", "role": "Developer" } ], @@ -25,12 +25,12 @@ }, "autoload": { "psr-4": { - "VendorName\\Skeleton\\": "src" + "Spatie\\Fork\\": "src" } }, "autoload-dev": { "psr-4": { - "VendorName\\Skeleton\\Tests\\": "tests" + "Spatie\\Fork\\Tests\\": "tests" } }, "scripts": { diff --git a/configure-skeleton.sh b/configure-skeleton.sh deleted file mode 100755 index 1abf649..0000000 --- a/configure-skeleton.sh +++ /dev/null @@ -1,136 +0,0 @@ -#!/bin/bash -# 'return' when run as "source