README

这是远程屏幕的 API。

安装

您可以在项目中安装此 API，只需运行 composer require appshed/extension-api。

如果您不想使用 composer，您可以下载 phar。这是一个包含您所需所有内容的包，您只需要 require_once 'appshed-api.phar'。查看 phar-examples 文件夹以了解其使用方法。

如果您想从此存储库运行示例，请确保运行 composer install。

您可以在 GitHub 页面上查看 API 文档。

请在提交前确保更新 phar。您需要使用 Box 来完成此操作。

构建 phar

./vendor/bin/box build -v

API 文档是使用 sami 构建的。

生成 API 文档

./vendor/bin/sami.php update sami.php

然后，您可以将文档文件夹提交到 gh-pages 分支，类似于

mv doc ~/doc-tmp
git checkout gh-pages
rm -rf .
mv ~/doc-tmp/* .
git add .
git commit

要运行测试

./vendor/bin/phpunit