morningtrain/wp-plugin-updater

Add update functionality to plugins from private plugin repo

v0.3.0 2023-03-13 08:44 UTC

MIT

• Martin Schadegg Brønniche

README

Make it possible to update a plugin through a private plugin repo.

Table of Contents

• Introduction
• Getting Started
  • Installation
• Usage
  • Initialize
• Contributing
• Contributors
• License

Introduction

Make it possible to update a plugin through a private plugin repo.

Getting Started

To get started install the package as described below in Installation.

To use the tool have a look at Usage

Installation

Install with composer

composer require morningtrain/wp-plugin-updater

Usage

Getting started

Initialize

Construct at new Morningtrain\WP\PluginUpdater\PluginUpdater with url to the private plugin repo json info and plugin information (slug, base name and plugin version).

// plugin.php
require __DIR__ . "/vendor/autoload.php";

new \Morningtrain\WP\PluginUpdater\PluginUpdater(
    '[PLUGIN_INFO_JSON_URL]',
    '[PLUGIN_SLUG]',
    '[PLUGIN_BASE_NAME]',
    '[PLUGIN_VERSION]'
)

Contributing

Thank you for your interest in contributing to the project.

Bug Report

If you found a bug, we encourage you to make a pull request.

To add a bug report, create a new issue. Please remember to add a telling title, detailed description and how to reproduce the problem.

Support Questions

We do not provide support for this package.

Pull Requests

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

• Martin Schadegg Brønniche
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Developed by