diff --git a/README.md b/README.md index 22d4be3..b6eedb5 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,23 @@ -# Screenly Zapier Integration +

+Screenly Zapier Integration +

- Screenly for Zapier + Screenly for Zapier

-[![Test](https://github.com/screenly/zapier/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/screenly/zapier/actions/workflows/test.yml) +

+ + Test Status + +

-A Zapier integration for automating Screenly digital signage operations. Connect your +A Zapier [integration](https://zapier.com/apps/screenly/integrations) for automating Screenly digital signage operations. Connect your Screenly displays with 5000+ apps. ## :rocket: Quick Start -### Step 1 — Install the Integration - -> [!NOTE] -> There is no public version of this integration yet. In the meantime, you can -> install it privately by following the steps below. - - - Run the following command to set up and install the integration privately: - - ```bash - zapier login - zapier register "Screenly" - ``` - - - Push the changes to Zapier: - - ```bash - zapier push - ``` - -### Step 2 — Create Your First Zap - - - Go to [Zapier](https://zapier.com). - - Go to the sidebar and click "Create". - - Choose your trigger app (e.g., Dropbox, SharePoint, Google Drive). - We will use Dropbox as an example. - - Select a "Trigger event" from the list of available events. For example, - select "New File in Folder". Configure what directory you want to monitor. - - Choose Screenly as your action app. - - Select the action event that you want to be executed. For example, - select "Upload Asset". Click "Continue". - - Configure the "Action Event". For example, select the folder you want to monitor. - - For the "Account", link your Screenly account. - It should open a new window that asks for your Screenly API token. Once - you confirm, it should be linked to your Zap. - - Click "Continue". - - For "File URL", select "Direct Media Link". - - For "Title", select "File Name". - - Click "Continue". Feel free to "Skip test". - - Click "Publish". - - Make sure that the Zap is enabled. - - Upload your file to the folder you configured. - - Go to your Screenly dashboard and click "Content" from the sidebar. - - You should see the new asset that was uploaded. +You can start by creating a new workflow that will create a new Screenly asset when a new file is uploaded to a specific folder in your Google Drive. Please see this [guide](/docs/cookbook/uploading-an-asset-via-google-drive.md) for details. ## :zap: Quick Links @@ -67,4 +31,4 @@ Screenly displays with 5000+ apps. - API keys are stored securely by Zapier - All API requests are made over HTTPS -- The integration follows Zapier's security best practices \ No newline at end of file +- The integration follows Zapier's security best practices diff --git a/docs/developer-documentation.md b/docs/developer-documentation.md index e1637c9..069aa41 100644 --- a/docs/developer-documentation.md +++ b/docs/developer-documentation.md @@ -126,6 +126,20 @@ These tests are skipped locally to avoid environment-specific issues. - Visual tests run on pull requests - CI checks must pass before merge +## Setting up Zapier Deployment + +1. Get your Zapier Deploy Key: + + ```bash + zapier login + zapier register "Screenly" # Only needed for first-time setup + ``` + +2. Add the deploy key to GitHub: + - Go to your repository's Settings > Secrets > Actions + - Add a new secret named `ZAPIER_DEPLOY_KEY` + - Paste your deploy key as the value + ## Deployment The integration is automatically deployed to Zapier when a new version tag is pushed to GitHub. @@ -141,19 +155,11 @@ The integration is automatically deployed to Zapier when a new version tag is pu - Run tests - Deploy to Zapier -## Setting up Zapier Deployment - -1. Get your Zapier Deploy Key: - - ```bash - zapier login - zapier register "Screenly" # Only needed for first-time setup - ``` +If you wish to deploy the integration privately, you can do so by following the steps below, given that you have completed the [initial setup steps above](#setting-up-zapier-deployment). -2. Add the deploy key to GitHub: - - Go to your repository's Settings > Secrets > Actions - - Add a new secret named `ZAPIER_DEPLOY_KEY` - - Paste your deploy key as the value +```bash +zapier push +``` ## Version Management