mirror
/
plugin-update-checker
mirror of https://github.com/YahnisElsts/plugin-update-checker.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the docs to more clearly separate usage instructions for GitLab.com and self-hosted GitLab instances.

This commit is contained in:
Yahnis Elsts 2019-01-04 19:13:39 +02:00
parent 9d087b7d9c
commit 57a25d905a
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -235,19 +235,23 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli
'unique-plugin-or-theme-slug'
);
//Note: Self-hosted instances of GitLab must be initialized like this:
$myUpdateChecker = new Puc_v4p5_Vcs_PluginUpdateChecker(
new Puc_v4p5_Vcs_GitLabApi('https://myserver.com/user-name/repo-name/'),
__FILE__,
'unique-plugin-or-theme-slug'
);
//Optional: If you're using a private repository, specify the access token like this:
$myUpdateChecker->setAuthentication('your-token-here');
//Optional: Set the branch that contains the stable release.
$myUpdateChecker->setBranch('stable-branch-name');
```
Alternatively, if you're using a self-hosted GitLab instance, initialize the update checker like this:
```php
$myUpdateChecker = new Puc_v4p5_Vcs_PluginUpdateChecker(
new Puc_v4p5_Vcs_GitLabApi('https://myserver.com/user-name/repo-name/'),
__FILE__,
'unique-plugin-or-theme-slug'
);
//Optional: Add setAuthentication(...) and setBranch(...) as shown above.
```
3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link.
#### How to Release an Update