diff --git a/README.md b/README.md index 14adbdc6..9d08d385 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ Getting Started ### Self-hosted Plugins 1. Make a JSON file that describes your plugin. Here's a minimal example: - ```json + + ```json { "name" : "My Cool Plugin", "version" : "2.0", @@ -23,11 +24,12 @@ Getting Started "description" : "Plugin description here. You can use HTML." } } - ``` + ``` See [this table](https://spreadsheets.google.com/pub?key=0AqP80E74YcUWdEdETXZLcXhjd2w0cHMwX2U1eDlWTHc&authkey=CK7h9toK&hl=en&single=true&gid=0&output=html) for a full list of supported fields. 2. Upload this file to a publicly accessible location. 3. Download [the update checker](https://github.com/YahnisElsts/plugin-update-checker/releases/latest), unzip the archive and copy the `plugin-update-checker` directory to your plugin. 4. Add the following code to the main plugin file: + ```php require 'plugin-update-checker/plugin-update-checker.php'; $myUpdateChecker = PucFactory::buildUpdateChecker( @@ -47,6 +49,7 @@ Getting Started 1. Download [the latest release](https://github.com/YahnisElsts/plugin-update-checker/releases/latest), unzip it and copy the `plugin-update-checker` directory to your plugin. 2. Add the following code to the main file of your plugin: + ```php require 'plugin-update-checker/plugin-update-checker.php'; $className = PucFactory::getLatestClassVersion('PucGitHubChecker'); @@ -91,4 +94,4 @@ The GitHub version of the library will pull update details from the following pa - Remote plugin headers (i.e. the latest version on GitHub). - Local plugin headers (i.e. the currently installed version). - Ratings, banners, screenshots - - Not supported. \ No newline at end of file + - Not supported.