forked from afragen/git-updater
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
54 lines (38 loc) · 2.07 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# GitHub Updater
Contributors: afragen, garyj, scarstens, limikael
Donate link: http://thefragens.com/github-updater-donate
Tags: plugin, theme, language pack, updater, remote install
Requires at least: 4.4
Tested up to: 4.9
Stable tag: master
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
## Description
This plugin was designed to simply update any GitHub hosted WordPress plugin or theme. Currently, plugins or themes hosted on GitHub, Bitbucket, or GitLab are also supported. Additionally, self-hosted installations of GitHub or GitLab are supported. It also allows for remote installation of plugins or themes into WordPress.
Your plugin or theme **must** contain a header in the style.css header or in the plugin's header denoting the location on GitHub. The format is as follows.
`GitHub Plugin URI: afragen/github-updater`
`GitHub Plugin URI: https://github.com/afragen/github-updater`
or
`GitHub Theme URI: afragen/test-child`
`GitHub Theme URI: https://github.com/afragen/test-child`
...where the above URI leads to the __owner/repository__ of your theme or plugin. The URI may be in the format `https://github.com/<owner>/<repo>` or the short format `<owner>/<repo>`. You do not need both. Only one Plugin or Theme URI is required. You **must not** include any extensions like `.git`.
The following headers are available for use depending upon your hosting source.
### GitHub
* GitHub Plugin URI
* GitHub Theme URI
* GitHub Branch
* GitHub Languages
### Bitbucket
* Bitbucket Plugin URI
* Bitbucket Theme URI
* Bitbucket Branch
* Bitbucket Languages
### GitLab
* GitLab Plugin URI
* GitLab Theme URI
* GitLab Branch
* GitLab Languages
* GitLab CI Job
[Comprehensive information regarding GitHub Updater is available on the wiki.](https://github.com/afragen/github-updater/wiki)
## Slack
We now have a [Slack team for GitHub Updater](https://github-updater.slack.com). Please [click here for an invite](https://github-updater.herokuapp.com). You will be automatically added to the _#general_ and _#random_ channels. Please take a look at other channels too.