forked from afragen/git-updater
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
58 lines (38 loc) · 2.45 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
55
56
57
58
# Git Updater
Contributors: afragen
Donate link: https://thefragens.com/git-updater-donate
Tags: plugin, theme, language pack, updater, remote install
Requires at least: 5.2
Requires PHP: 7.0
Tested up to: 5.7
Stable tag: master
License: GPLv2 or later
License URI: https://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 Bitbucket, GitLab, Gitea, or Gist are also supported via additional API plugins. Additionally, self-hosted git servers 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/git-updater
GitHub Plugin URI: https://github.com/afragen/git-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`.
### API plugins
API plugins for Bitbucket, GitLab, Gitea, and Gist are available.
* [Git Updater - Bitbucket](https://github.com/afragen/git-updater-bitbucket/releases/latest)
* [Git Updater - GitLab](https://github.com/afragen/git-updater-gitlab/releases/latest)
* [Git Updater - Gitea](https://github.com/afragen/git-updater-gitea/releases/latest)
* [Git Updater - Gist](https://github.com/afragen/git-updater-gist/releases/latest)
### Sponsor
You can [sponsor me on GitHub](https://github.com/sponsors/afragen) to help with continued development and support.
### Headers
The following headers are available for use depending upon your hosting source.
#### GitHub
* GitHub Plugin URI
* GitHub Theme URI
* GitHub Languages
## Frequently Asked Questions
#### Wiki
[Comprehensive information regarding Git Updater is available on the wiki.](https://github.com/afragen/git-updater/wiki)
#### Slack
We now have a [Slack team for Git 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 _#support_ channels. Please take a look at other channels too.