From 930d75c63ccad9f7ad368f53fc0b324a16f331bc Mon Sep 17 00:00:00 2001 From: Kevin Ullyott Date: Tue, 28 Dec 2021 23:05:53 -0500 Subject: [PATCH] More Readme updates and composer.json Signed-off-by: Kevin Ullyott --- composer.json | 11 +++++++++++ readme.md | 14 +++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/composer.json b/composer.json index e059758..b5cbd9b 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,17 @@ { "name": "orrison/cumulus", + "description": "Import DNS records from Laravel Vapor into Cloudflare", + "keywords": [ + "laravel", + "vapor", + "cloudflare", + "dns" + ], + "homepage": "https://github.com/Orrison/cumulus", "license": "MIT", + "bin": [ + "cumulus" + ], "autoload": { "psr-4": { "Cumulus\\Cumulus\\": "src/" diff --git a/readme.md b/readme.md index 3b79923..528773b 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,7 @@ # Cumulus -[![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) -[![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/orrison/cumulus.svg?style=flat-square)](https://packagist.org/packages/orrison/cumulus) +[![Total Downloads](https://img.shields.io/packagist/dt/orrison/cumulus.svg?style=flat-square)](https://packagist.org/packages/orrison/cumulus) Cumulus is a package to be used with the Laravel Vapor CLI. It provides a set of commands to import DNS records for your Vapor custom domain into Cloudflare. @@ -11,9 +11,17 @@ No more having to copy each manually which takes too long and is prone to errors ## Installation ```bash -composer global require cumulus/cumulus +composer global require orrison/cumulus --with-all-dependencies ``` --- ## Usage +In order to use Cumulus, you will need a valid Cloudflare API Access Token. You can get one by following the instructions in their [Documentation](https://developers.cloudflare.com/api/tokens/create). + +The "Edit DNS Zone" template is perfect for this. You will just need set the "Zone Resources" options to either `All Zones` or the correct option for your use case. + +Once you have your token you can run the following command to input your token. It is then stored for use in future commands. +```bash +cumulus cloudlfare:login +``` \ No newline at end of file