# README #

This is a Plugin from Eye-Able for Wordpress.

### What is this repository for? ###

* With this Plugin Wordpress User can easily add the assistant software from Eye-Able to their website. 


### **Before publishing the Plugin** ###
Clone this repository. In case the Main Repo is cloned -> checkout to this branch and make a pull request. Now you should have the latest Version of this repository. 
To implement an automatic Updatechecker only small adjustments are necessary. 

1. Go to the directory "plugin-update-checker" and there to the subdirectory "examples" and open the plugin.json file. 
   It looks like this:    
   ```

	"name": "Eye-Able Wordpress Plugin",
	"version": "2.7.19",
	"download_url": "https://cdn.eye-able.com/plugins/wordpress/wordpress-eye-able-assistant.zip",

   ```
    This is a minimal example that leaves out many more optional fields. 
	Here is a list with full supported fields : (https://docs.google.com/spreadsheets/d/1eOBbW7Go2qEQXReOOCdidMTf_tDYRq4JfegcO1CBPIs/edit?usp=sharing)
	The name field is the name of the Plugin. **Important**: When there is a change in the folderstructure -> change the download_url to the path, where the ZIP file is located.
	(ZIP the whole Folder that belongs to this repository) 
	
2. Go to the main plugin php script. In our case this is the **eyeAbleTestbox.php**. 
	There you will find this code: 
	
```
require 'plugin-update-checker-4.13/plugin-update-checker.php';
$myUpdateChecker = Puc_v4_Factory::buildUpdateChecker(
	'https://cdn.eye-able.com/plugins/wordpress/wordpress-eye-able-assistant/plugin-update-checker-4.13/examples/plugin.json',
	__FILE__, //Full path to the main plugin file or functions.php.
	'wordpress-eye-able-assistant'
);
```
	Again in case of changing the folder structure : we need to adjust the path where the JSON file from 1. is located.  

### **How to release an Update**###
	1. Modify and make adjustment to the code. Add features etc. 
	2. Change the Version Number in the JSON and eyeAbleTestbox.php. If necessary change also the other fields in the JSON file 
	3. Safe the changes and ZIP the whole Folder. The ZIP file should be located at the path we have defined in the JSON.