Skip to content
This repository has been archived by the owner on Sep 26, 2021. It is now read-only.

Commit

Permalink
Shortcuts rename (#37)
Browse files Browse the repository at this point in the history
* Update naming to Shortcuts

Updated Workflow Directory to become Shortcuts Directory

* Update issue templates
  • Loading branch information
jordanmerrick committed Oct 4, 2018
1 parent ae470e7 commit 9073f54
Show file tree
Hide file tree
Showing 211 changed files with 30 additions and 35 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
@@ -1,5 +1,5 @@
(You can delete this text before creating your issue) (You can delete this text before creating your issue)


If you're experiencing a problem with a workflow, you can report the issue here and someone may be able to help. Provide a suitable title and description of the problem, along with which workflow is affected. Please assign the **problem** label to issues. In most cases, you should contact the workflow submitter first (available in the workflow's README). If you're experiencing a problem with a shortcut, you can report the issue here and someone may be able to help. Provide a suitable title and description of the problem, along with which shortcut is affected. Please assign the **problem** label to issues. In most cases, you should contact the shortcut's submitter first (available in the shortcut's README).


You can also create an issue to submit a workflow. Please include a title, description, and **workflow.is** link. You can also create an issue to submit a shortcut. Please include a title, description, and iCloud link.
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,10 +1,10 @@
If you're submitting a new workflow, make sure that you have completed the following steps and these boxes are checked If you're submitting a new shortcut, make sure that you have completed the following steps and these boxes are checked


- [ ] Created a new directory for your workflow - [ ] Created a new directory for your shortcut
- [ ] The **.wflow** file has been placed in this directory - [ ] The **.shortcut** file has been placed in this directory
- [ ] A README.md has been created and added to this directory - [ ] A README.md has been created and added to this directory


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


- [ ] Overwritten the existing **.wflow** file - [ ] Overwritten the existing **.shortcut** (or **.wflow**) file
- [ ] Updated the README.md (if required) - [ ] Updated the README.md (if required)
35 changes: 15 additions & 20 deletions CONTRIBUTING.md
@@ -1,46 +1,41 @@
You can submit a new workflow, or an update to an existing one, in three different ways: You can submit a new shortcut, or an update to an existing one, in three different ways:


- Submitting a pull request - Submitting a pull request
- Creating an issue on GitHub - Creating an issue on GitHub
- Use the **Submit to Workflow Directory** workflow


If your workflow 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 workflow. 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 ## Submitting a pull request


If you're familiar with Git, you can create a pull request containing the workflow you wish to add. When creating a pull request, make sure that the following steps are taken: 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 workflow - Create a new directory for your shortcut
- The **.wflow** workflow file is placed in this directory - The **.shortcut** file is placed in this directory
- A README.md is created and added to this directory - A README.md is created and added to this directory


### Format for README ### Format for README


The README for a workflow uses the following structure: The README for a shortcut uses the following structure:


# Workflow Title # Shortcut Title


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


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


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


### Updating a workflow ### Updating a shortcut


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


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


## Creating an issue on Github ## Creating an issue on Github


The easiest way to submit a workflow is to create a new issue on GitHub. A GitHub account is required. Follow the issue template and provide: 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:


- Workflow name - Shortcut name
- A description - A description
- Link to the workflow at **workflow.is** - iCloud link to the shortcut

## Use the Submit to Workflow Directory workflow

You can use [this workflow](workflows/Submit%20to%20Workflow%20Directory/Submit%20to%20Workflow%20Directory.wflow) to create a submission request automatically. Copy the link for the workflow you want to submit and then run this workflow to create the required GitHub issue for you.
16 changes: 8 additions & 8 deletions README.md
@@ -1,17 +1,17 @@
# Workflow Directory # Shortcuts Directory


This repository contains user-submitted workflows for [Workflow for iOS](https://itunes.apple.com/us/app/workflow/id915249334?mt=8&uo=4&at=10l64N). This repository contains user-submitted shortcuts for [Shortcuts for iOS](https://itunes.apple.com/us/app/id915249334?at=10l64N).


All workflows are saved as **.wflow** files and located in the **workflows/** directory so that they are available without needing a **workflow.is** link. Each workflow includes a README with information about it. All shortcuts are saved as **.shortcut** files and located in the **shortcuts/** directory so that they are available without needing an iCloud link. Each shortcut includes a README with information about it. Older workflows are saved as **.wflow** files and are compatible with Shortcuts.


## Downloading workflows ## Downloading shortcuts


You don't need a GitHub account or be familiar with [Git](https://en.wikipedia.org/wiki/Git) to download workflows. You don't need a GitHub account or be familiar with [Git](https://en.wikipedia.org/wiki/Git) to download shortcuts.


- If you're viewing the repository on GitHub, select the workflow file you want and then tap **Download**. - If you're viewing the repository on GitHub, select the shortcut file you want and then tap **Download**.
- You can clone the repository using an app like [Working Copy](https://itunes.apple.com/us/app/working-copy-powerful-git-client/id896694807?mt=8&uo=4&at=10l64N) (one of my favorite iOS apps). This can be easily updated by pulling the latest changes at any time. - You can clone the repository using an app like [Working Copy](https://itunes.apple.com/us/app/working-copy-powerful-git-client/id896694807?mt=8&uo=4&at=10l64N) (one of my favorite iOS apps). This can be easily updated by pulling the latest changes at any time.
- You can also download the entire repository as a ZIP file by tapping **Clone or download** and select **Download ZIP**. - You can also download the entire repository as a ZIP file by tapping **Clone or download** and select **Download ZIP**.


## Submitting a workflow ## Submitting a shortcut


See the [Contributing guide](CONTRIBUTING.md) for instructions on submitting a new workflow (or updating an existing one). A GitHub account is required. See the [Contributing guide](CONTRIBUTING.md) for instructions on submitting a new shortcut (or updating an existing one). A GitHub account is required.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 9073f54

Please sign in to comment.