Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
41 lines (24 sloc) 1.48 KB

You can submit a new shortcut, or an update to an existing one, in three different ways:

  • Submitting a pull request
  • Creating an issue on GitHub

If your shortcut makes use of an API, make sure that you use Import Questions and remove your API keys before submitting. It should not violate an API developer's terms of service as it would result in consequences for the user of the shortcut.

Submitting a pull request

If you're familiar with Git, you can create a pull request containing the shortcut you wish to add. When creating a pull request, make sure that the following steps are taken:

  • Create a new directory for your shortcut
  • The .shortcut file is placed in this directory
  • A README.md is created and added to this directory

Format for README

The README for a shortcut uses the following structure:

# Shortcut Title

Submitted by: [@your_github_username](https://github.com/your_github_username)

A brief description of the shortcut (and any instructions, if necessary).

To export a shortcut, open the Share Sheet and select Share as File.

Updating a shortcut

If you're submitting an update to an existing shortcut:

  • Overwrite the existing .shortcut (or .wflow) file
  • Update the README.md (if required)

Creating an issue on Github

The easiest way to submit a shortcut is to create a new issue on GitHub. A GitHub account is required. Follow the issue template and provide:

  • Shortcut name
  • A description
  • iCloud link to the shortcut