# Penny Black Woocommerce Plugin

This plugin integrates Woocommerce to Penny Black, to provide the data for, and optionally trigger personalised prints.

## Installation

* Download the latest release from the [releases page](https://github.com/pennyblack-io/woocommerce-pennyblack/releases)
* Extract the zip file and rename the folder to `woocommerce-pennyblack`, removing the version number component.
* Inside the folder run `composer install --no-dev`.
* Create a zip file from the `woocommerce-pennyblack` folder.
* Upload the folder to your WordPress site, either manually to the plugins directory, or via the admin interface on the plugins page.
* Install the plugin from the WordPress admin panel.
* Follow the settings link on the plugins page to configure the plugin:
  * Set the API key that received from Penny Black support
  * Enable order transmission
  * If you fulfil your own orders through Woocommerce then enable the order admin extensions.

## Development

### Releasing a new version of the plugin

* If a new version of the Penny Black PHP SDK is being used remember to update its version number in `composer.json`, and run `composer update`.
* Bump the version number in the following 3 files:
  * `woocommerce-pennyblack.php`
  * `readme.txt`
  * `composer.json`
* Create a new release on GitHub, with the version number as the tag, and the version number as the title.
* On publishing a new tag a GitHub action will automatically deploy the updated version to the WordPress plugin repository. See our page [here](https://wordpress.org/plugins/penny-black/). 

### Releasing updated assets (screenshots, banners logos) to WP.org

There is a GitHub action listening for changes to these files. Any commit to `main` that contains _only_ changes to `readme.txt` and/or `.wordpress-org/` folders will trigger a push to update them on WP.org in their respective folders