Updated PHP requirements and README

BitcoinMitchell · Nov 3, 2021 · 506903c · 506903c
1 parent 2bbbd59
commit 506903c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -5,20 +5,37 @@
 [![GitHub License](https://img.shields.io/github/license/bitcoinmitchell/cryptwerk-plugin?color=brightgreen&style=flat-square)](https://github.com/bitcoinmitchell/cryptwerk-plugin/blob/master/LICENSE)
 [![GitHub contributors](https://img.shields.io/github/contributors-anon/bitcoinmitchell/cryptwerk-plugin?style=flat-square)](https://github.com/bitcoinmitchell/cryptwerk-plugin/graphs/contributors)
 
-[![PrestaShop module version](https://img.shields.io/badge/module%20version-0.3.0-brightgreen?style=flat-square)](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
+[![PrestaShop module version](https://img.shields.io/badge/module%20version-0.3.1-brightgreen?style=flat-square)](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/bitcoinmitchell/cryptwerk-plugin?sort=semver&style=flat-square)](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
 [![GitHub all releases](https://img.shields.io/github/downloads/bitcoinmitchell/cryptwerk-plugin/total?style=flat-square)](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
 
-This is a CryptWerk plugin for PrestaShop using.
+This is a CryptWerk plugin for PrestaShop. It converts your available products into a XML feed that CryptWerk can parse.
+
+## Requirements
+
+Please ensure that you meet the following requirements before installing this plugin.
+
++ You have a [CryptWerk account](https://cryptwerk.com/id/register/).
++ You are using PHP 7.3 or higher.
++ Your PrestaShop is version 1.7.7.0 or higher.
++ The intl, mbstring and simplexml PHP extensions are available.
+
+## Usage
+
+1. [Download the latest CryptWerk plugin](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases).
+2. Go to your PrestaShop store and upload the zip you just downloaded via `Modules > Module Manager > Upload a module`.
+4. Click on `Catalog -> CryptWerk Feed`, which will redirect you to your proper `feed` URL, copy that.
+5. Setup the sync within CryptWerk (`https://cryptwerk.com/company/YOUR-COMPANY/market-sync/`) using `XML`.
+6. Done (now you just need to await moderator approval).
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the 
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
 [tags on this repository](https://github.com/BitcoinMitchell/docker-prestashop/tags).
 
 ## Contributing
 
-Contributors looking to help out, before opening a pull request, please [create an issue](https://github.com/bitcoinmitchell/cryptwerk-plugin/issues/new/choose) 
+Contributors looking to help out, before opening a pull request, please [create an issue](https://github.com/bitcoinmitchell/cryptwerk-plugin/issues/new/choose)
 to get early feedback, discuss the best ways to tackle the problem and to ensure there is no work duplication.
 
 ## PrestaShop Support

diff --git a/modules/cryptwerk/composer.json b/modules/cryptwerk/composer.json
@@ -19,11 +19,7 @@
   "minimum-stability": "stable",
   "require": {
     "php": ">=7.3.0",
-    "ext-PDO": "*",
-    "ext-curl": "*",
-    "ext-gd": "*",
     "ext-intl": "*",
-    "ext-json": "*",
     "ext-mbstring": "*",
     "ext-simplexml": "*"
   },

diff --git a/modules/cryptwerk/composer.lock b/modules/cryptwerk/composer.lock
diff --git a/modules/cryptwerk/cryptwerk.php b/modules/cryptwerk/cryptwerk.php
@@ -29,7 +29,7 @@ public function __construct()
 	{
 		$this->name                   = 'cryptwerk';
 		$this->tab                    = 'administration';
-		$this->version                = '0.3.0';
+		$this->version                = '0.3.1';
 		$this->author                 = 'BitcoinMitchell';
 		$this->ps_versions_compliancy = ['min' => '1.7.7', 'max' => _PS_VERSION_];