Skip to content

Commit 58fff52

Browse files
committed
Update README.md
1 parent 1608081 commit 58fff52

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1-
# edd-software-github-sync
2-
Sync GitHub releases with EDD downloads that use Software Licensing
1+
# Easy Digital Downloads - Software GitHub Sync
2+
Sync GitHub releases with EDD downloads that use Software Licensing.
3+
4+
### Install
5+
6+
Install the plugin and edit your desired Download. In the **Software GitHub Sync** metabox that appears,
7+
enable the sync and save the download.
8+
9+
To setup the webhook on GitHub:
10+
11+
1. On your GitHub repository navigate to: **Settings > Webhooks & services > Add webhook**
12+
1. Enter the generated Payload URL (found in the **Software GitHub Sync** metabox)
13+
1. Select **Let me select individual events** and untick "Push" and tick "Release"
14+
1. Add the webhook and check the ping is ok
15+
16+
### Usage
17+
18+
When creating a release in GitHub attach your ZIP using the "Attach binaries" upload box. The EDD download will
19+
automatically be updated with this new file and the current version number will also be updated with the "Tag version"
20+
from the release.

0 commit comments

Comments
 (0)