diff --git a/README.md b/README.md index 177f8b4..2caa019 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,12 @@ With Bunny CDN's Storage Edge, your web applications benefit from replicated sto ## How do I use Bunny CLI? +To install Bunny CLI, you need to be using Composer. For more details about Composer, see the [Composer documentation](https://getcomposer.org/doc/). + +```bash +composer global require own3d/bunny-cli +``` + Bunny CLI currently only comes with a `deploy` command. With this command, you can easily synconizise your `dist` folder with your edge storage. > **IMPORTANT**: All files in the edge storage that are **not** in your local `dist` directory will be deleted. @@ -33,7 +39,7 @@ We offer you a [GitHub Action for Bunny CLI](https://github.com/marketplace/acti ``` - name: Deploy to Edge Storage - uses: ghostzero/bunny-action@main + uses: own3d/bunny-action@main env: BUNNY_API_ACCESS_KEY: ${{ secrets.BUNNY_API_ACCESS_KEY }} BUNNY_STORAGE_USERNAME: bunny-cli @@ -65,16 +71,6 @@ We hope that together with Bunny CDN, we can solve this problem. A: No. Bunny CLI is a community-driven tool and is not affiliated with Bunny CDN. -## Documentation - -For full documentation, visit [laravel-zero.com](https://laravel-zero.com/). - -## Support the development - -**Do you like this project? Support it by donating** - -- Patreon: [Donate](https://patreon.com/ghostzero) - ## License Bunny CLI is an open-source software licensed under the Apache 2.0 license. diff --git a/composer.json b/composer.json index 3d3492c..0fd5098 100644 --- a/composer.json +++ b/composer.json @@ -1,5 +1,5 @@ { - "name": "ghostzero/bunny", + "name": "own3d/bunny-cli", "description": "Replicate and store your files to the edge!", "keywords": ["bunny", "cdn", "console", "cli"], "homepage": "https://github.com/ghostzero/bunny-cli",