Skip to content

Commit 6a585af

Browse files
committed
README [ci skip]
1 parent da37283 commit 6a585af

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Airdrop for Laravel
2+
3+
[![Tests](https://github.com/hammerstonehq/airdrop/actions/workflows/tests.yml/badge.svg)](https://github.com/hammerstonehq/airdrop/actions/workflows/tests.yml)
4+
5+
> Read the full docs at [hammerstone.dev/airdrop/docs](https://hammerstone.dev/airdrop/docs/main/overview).
6+
7+
Hammerstone Airdrop for Laravel is a package that speeds up your deploys by skipping your asset build step whenever possible.
8+
9+
When you're deploying your code, Airdrop will calculate a hash of everything needed to build your assets: installed packages, JS/CSS files, ENV vars, etc.
10+
11+
After Airdrop has calculated a hash for these inputs, it will check to see if it has ever built this exact configuration before. If it has, it will pull down the built assets and put them in place, letting you skip the expensive build step.
12+
13+
14+
# Installation
15+
16+
You can install the package via Composer
17+
```console
18+
composer require hammerstone/airdrop
19+
```
20+
21+
Once the package is installed, you may optionally publish the config file by running
22+
```console
23+
php artisan airdop:install
24+
```
25+
26+
You'll likely want to publish the config file so that you can set up your triggers and outputs.
27+
28+
Read the full docs at [hammerstone.dev/airdrop/docs](https://hammerstone.dev/airdrop/docs/main/overview).

0 commit comments

Comments
 (0)