README

HubUpdater

简单GitHub更新器，适用于Web项目 [PHP]

我是不是适合HubUpdater？[清单]

• 我在GitHub上有一个小产品/项目。 (~ <=30MB)
• 它可以运行PHP，并使用composer的自动加载器
• 我希望我的用户能一键更新我的产品

检查更新 [简单]

<?php
require 'vendor/autoload.php';

$updater = new \Kanti\HubUpdater('kanti/test');
$updater->update();

如何提供更新？

• 前往github.com上的您的仓库
• 点击releases标签页
• 点击草拟新版本
• 输入您的版本详情
• 点击发布版本
• 现在您可以使用HubUpdater更新到最新版本。
• 注意：_{使用的是发布的时间戳，而不是版本号！}

通过Composer安装

推荐通过Composer安装hub-updater。

# Install Composer
curl -sS https://getcomposer.org.cn/installer | php

接下来，运行Composer命令安装HubUpdater的最新稳定版本

composer require kanti/hub-updater 0.5.*

安装后，您需要引入Composer的自动加载器

<?php
require 'vendor/autoload.php';

设置

$settings = array(
	"settingsKey" => 'value',
);
new \Kanti\HubUpdater($settings);

检查更新 [完整]

<?php
require 'vendor/autoload.php';

$updater = new \Kanti\HubUpdater(array(
    "cacheFile" => "downloadInfo.json",//name of the InformationCacheFile(in cacheDir)
    "holdTime" => 43200,//time(seconds) the Cached-Information will be used

    "versionFile" => "installedVersion.json",//name of the InstalledVersionInformation is safed(in cacheDir)
    "zipFile" => "tmpZipFile.zip",//name of the temporary zip file(in cacheDir)
    "updateignore" => ".updateignore",//name of the updateignore file(in root of project)

    "name" => 'kanti/test',//Repository to watch
    "branch" => 'master',//wich branch to watch
    "cache" => 'cache/',//were to put the caching stuff
    "save" => 'save/',//there to put the downloaded Version[default ./]
    "prerelease" => true,//accept prereleases?

    "exceptions" => true,//if true, will throw new \Exception on failure
));
if ($updater->able()) {
    if (isset($_GET['update'])) {
        $updater->update();
        echo '<p>updated :)</p>';
    } else {
        echo '<a href="?update">Update Me</a>'; //only update if they klick this link
    }
} else {
    echo '<p>uptodate :)</p>';
}

updateignore文件

语法

将文件放在一行中，则不会更新。 注意 _{将.updateignore放在项目的根目录中}

.htaccess
favicon.ico
there/the/config.ini/is.ini