Skip to content

Commit

Permalink
More Readme updates and composer.json
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Ullyott <[email protected]>
  • Loading branch information
Orrison committed Dec 29, 2021
1 parent 00562ae commit 930d75c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
11 changes: 11 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -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/"
Expand Down
14 changes: 11 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
```

0 comments on commit 930d75c

Please sign in to comment.