Skip to content

Commit

Permalink
Update package name, author, and description.
Browse files Browse the repository at this point in the history
  • Loading branch information
thejmitchener committed Mar 22, 2024
1 parent af00550 commit 858deac
Show file tree
Hide file tree
Showing 28 changed files with 307 additions and 564 deletions.
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 `laravel-cloudflare-cache` 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) fuelviews <support@fuelviews.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
63 changes: 30 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,55 @@
# :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/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+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-->
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
# Fuelviews cloudflare cache package

## Installation
[![Latest Version on Packagist](https://img.shields.io/packagist/v/fuelviews/laravel-cloudflare-cache.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-cloudflare-cache)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-cloudflare-cache/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/fuelviews/laravel-cloudflare-cache/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-cloudflare-cache/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/fuelviews/laravel-cloudflare-cache/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/fuelviews/laravel-cloudflare-cache.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-cloudflare-cache)

You can install the package via composer:
The Fuelviews cloudflare cache package for laravel offers an efficient way to manage cloudflare's cache directly from your Laravel application, streamlining the purge process to ensure your content remains fresh.

```bash
composer require :vendor_slug/:package_slug
```
## Installation

You can publish and run the migrations with:
You can install the package via composer:

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan migrate
composer require fuelviews/laravel-cloudflare-cache
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag=":package_slug-config"
php artisan vendor:publish --tag="cloudflare-cache-config"
```

This is the contents of the published config file:

```php
<?php

return [
/**
* Generate global api key.
*
* @see https://dash.cloudflare.com/profile/api-tokens
*/
'api_key' => env('CLOUDFLARE_CACHE_KEY'),

/**
* zone_id of your site on cloudflare dashboard.
*/
'identifier' => env('CLOUDFLARE_CACHE_IDENTIFIER'),

'debug' => env('CLOUDFLARE_CACHE_DEBUG', false),
];
```

Optionally, you can publish the views using

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

## Usage

Purges everything

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
CloudflareCache::purgeEverything()
```

## Testing
Expand All @@ -79,6 +74,8 @@ Please review [our security policy](../../security/policy) on how to report secu

- [Thejmitchener](https://github.com/thejmitchener)
- [Fuelviews](https://github.com/fuelviews)
- [Yediyuz](https://github.com/yediyuz)
- [Mertasan](https://github.com/mertasan)
- [All Contributors](../../contributors)

## Support us
Expand Down
34 changes: 15 additions & 19 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,53 +1,49 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "fuelviews/laravel-cloudflare-cache",
"description": "Fuelviews cloudflare cache package",
"keywords": [
":vendor_name",
"fuelviews",
"laravel",
":package_slug"
"laravel-cloudflare-cache"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/fuelviews/laravel-cloudflare-cache",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Joshua Mitchener",
"email": "support@fuelviews.com",
"role": "Developer"
}
],
"require": {
"php": "^8.2",
"guzzlehttp/guzzle": "^7.8",
"spatie/laravel-package-tools": "^1.16",
"illuminate/routing": "^10.10|^11.0",
"illuminate/contracts": "^10.0||^11.0"
},
"require-dev": {
"laravel/pint": "^1.14",
"nunomaduro/collision": "^8.1.1||^7.10.0",
"larastan/larastan": "^2.9",
"orchestra/testbench": "^9.0.0||^8.22.0",
"pestphp/pest": "^2.34",
"pestphp/pest-plugin-arch": "^2.7",
"pestphp/pest-plugin-laravel": "^2.3",
"phpstan/extension-installer": "^1.3",
"phpstan/phpstan-deprecation-rules": "^1.1",
"phpstan/phpstan-phpunit": "^1.3",
"spatie/laravel-ray": "^1.35"
"pestphp/pest-plugin-laravel": "^2.3"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"Fuelviews\\CloudflareCache\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/",
"Fuelviews\\CloudflareCache\\Tests\\": "tests/",
"Workbench\\App\\": "workbench/app/"
}
},
"scripts": {
"post-autoload-dump": "@composer run prepare",
"clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
"clear": "@php vendor/bin/testbench package:purge-laravel-cloudflare-cache --ansi",
"prepare": "@php vendor/bin/testbench package:discover --ansi",
"build": [
"@composer run prepare",
Expand All @@ -73,10 +69,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Fuelviews\\CloudflareCache\\CloudflareCacheServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"CloudflareCache": "Fuelviews\\CloudflareCache\\Facades\\CloudflareCache"
}
}
},
Expand Down
17 changes: 17 additions & 0 deletions config/cloudflare-cache.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

return [
/**
* Generate global api key.
*
* @see https://dash.cloudflare.com/profile/api-tokens
*/
'api_key' => env('CLOUDFLARE_CACHE_KEY'),

/**
* zone_id of your site on cloudflare dashboard.
*/
'identifier' => env('CLOUDFLARE_CACHE_IDENTIFIER'),

'debug' => env('CLOUDFLARE_CACHE_DEBUG', false),
];
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

Loading

0 comments on commit 858deac

Please sign in to comment.