Skip to content

Commit

Permalink
Docs, badges. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
aarondfrancis committed May 16, 2021
1 parent 5cfe0b0 commit ad7ca48
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Airdrop for Laravel

[![Tests](https://github.com/hammerstonehq/airdrop/actions/workflows/tests.yml/badge.svg)](https://github.com/hammerstonehq/airdrop/actions/workflows/tests.yml)
[![Tests](https://github.com/hammerstonehq/airdrop/actions/workflows/tests.yml/badge.svg)](https://github.com/hammerstonehq/airdrop/actions/workflows/tests.yml) [![Latest Stable Version](https://poser.pugx.org/hammerstone/airdrop/v)](//packagist.org/packages/hammerstone/airdrop) [![Total Downloads](https://poser.pugx.org/hammerstone/airdrop/downloads)](//packagist.org/packages/hammerstone/airdrop) [![License](https://poser.pugx.org/hammerstone/airdrop/license)](//packagist.org/packages/hammerstone/airdrop)

> Read the full docs at [hammerstone.dev/airdrop/docs](https://hammerstone.dev/airdrop/docs/main/overview).
Expand Down
45 changes: 22 additions & 23 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,29 +32,28 @@ The `outputs` section of the config file defines which files are generated as th
config/airdrop.php{.filename}
```php
[
// ...
'outputs' => [
/*
* Files or folders that should be included.
*/
'include' => [
// The mix-manifest file tells Laravel how to get your versioned assets.
public_path('mix-manifest.json'),

// Compiled CSS.
public_path('css'),

// Compiled JS.
public_path('js'),
],

/*
* Files or folders that should be excluded or ignored.
*/
'exclude' => [
//
],
]
// ...
'outputs' => [
/*
* Files or folders that should be included.
*/
'include' => [
// The mix-manifest file tells Laravel how to get your versioned assets.
public_path('mix-manifest.json'),

// Compiled CSS.
public_path('css'),

// Compiled JS.
public_path('js'),
],

/*
* Files or folders that should be excluded or ignored.
*/
'exclude' => [
//
],
];
```

Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
# Installation

You can install the package via Composer
```console
```text
composer require hammerstone/airdrop
```

Once the package is installed, you may optionally publish the config file by running
```console
```text
php artisan airdrop:install
```

Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ After Airdrop has calculated a hash for these inputs, it will check to see if it
This can reduce the time your deploys and CI runs take from minutes down to just a few seconds:

<div class='flex justify-center my-4'>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">We&#39;ve sped up our <a href="https://twitter.com/ChipperCI?ref_src=twsrc%5Etfw">@ChipperCI</a> pipeline quite a bit by not building our assets if nothing on the frontend has changed, but instead downloading them from S3 already built.<br><br>Usually takes 1-3 minutes to build the assets, we can pull them off of S3 in seconds! <a href="https://t.co/owdZOEcJwP">pic.twitter.com/owdZOEcJwP</a></p>&mdash; Aaron Francis (@aarondfrancis) <a href="https://twitter.com/aarondfrancis/status/1180161402188771328?ref_src=twsrc%5Etfw">October 4, 2019</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">We&#39;ve sped up our <a href="https://twitter.com/ChipperCI?ref_src=twsrc%5Etfw">@ChipperCI</a> pipeline quite a bit by not building our assets if nothing on the frontend has changed, but instead downloading them from S3 already built.<br><br>Usually takes 1-3 minutes to build the assets, we can pull them off of S3 in seconds! <a href="https://t.co/owdZOEcJwP">pic.twitter.com/owdZOEcJwP</a></p>&mdash; Aaron Francis (@aarondfrancis) <a href="https://twitter.com/aarondfrancis/status/1180161402188771328?ref_src=twsrc%5Etfw">October 4, 2019</a></blockquote>
</div>

0 comments on commit ad7ca48

Please sign in to comment.