Merge pull request #61 from umbraco/feature/emerchantpay-package-readme

Package readme & fix Approve bool parse

Author: acoumb

src/Umbraco.Forms.Integrations.Commerce.EMerchantPay/PaymentProviderWorkflow.cs

@@ -187,7 +187,7 @@ public override WorkflowExecutionStatus Execute(Record record, RecordEventArgs e
                 TransactionId = transactionId.ToString(),
                 Usage = _paymentProviderSettings.Usage,
                 NotificationUrl = $"{_paymentProviderSettings.UmbracoBaseUrl}umbraco/api/paymentprovider/notifypayment" +
-                    $"?formId={formId}&recordUniqueId={recordUniqueId}&statusFieldId={statusKey}&approve={bool.Parse(Approve)}",
+                    $"?formId={formId}&recordUniqueId={recordUniqueId}&statusFieldId={statusKey}&approve={(bool.TryParse(Approve, out bool approve) ? approve : false)}",
                 ReturnSuccessUrl = _urlHelper.GetPageUrl(int.Parse(SuccessUrl)),
                 ReturnFailureUrl = _urlHelper.GetPageUrl(int.Parse(FailureUrl)),
                 ReturnCancelUrl = _urlHelper.GetPageUrl(int.Parse(CancelUrl)),

src/Umbraco.Forms.Integrations.Commerce.EMerchantPay/Umbraco.Forms.Integrations.Commerce.EMerchantPay.csproj

@@ -11,11 +11,12 @@
 		<PackageIconUrl></PackageIconUrl>
 		<PackageProjectUrl>https://github.com/umbraco/Umbraco.Forms.Integrations/tree/main/src/Umbraco.Forms.Integrations.Commerce.EMerchantPay</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/umbraco/Umbraco.Forms.Integrations</RepositoryUrl>
-		<Version>1.0.1</Version>
+		<Version>1.0.2</Version>
 		<Authors>Umbraco HQ</Authors>
 		<Company>Umbraco</Company>
 		<PackageTags>Umbraco;Umbraco-Marketplace</PackageTags>
 		<PackageIcon>emerchantpay.png</PackageIcon>
+		<PackageReadmeFile>readme.md</PackageReadmeFile>
 	</PropertyGroup>
 
 	<ItemGroup Condition="'$(TargetFramework)' == 'net472'">
@@ -44,6 +45,10 @@
 			<PackagePath>\</PackagePath>
 		</Content>
 	</ItemGroup>
+	
+	<ItemGroup>
+        <None Include="readme.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 
 	<Target Name="RemoveLuceneAnalyzer" BeforeTargets="CoreCompile">
 		<ItemGroup>

src/Umbraco.Forms.Integrations.Commerce.EMerchantPay/package.xml

@@ -3,7 +3,7 @@
 	<info>
 		<package>
 			<name>Umbraco.Forms.Integrations.Commerce.emerchantpay</name>
-			<version>1.0.1</version>
+			<version>1.0.2</version>
 			<iconUrl></iconUrl>
 			<licence url="https://opensource.org/licenses/MIT">MIT</licence>
 			<url>https://github.com/umbraco/Umbraco.Forms.Integrations</url>

src/Umbraco.Forms.Integrations.Commerce.EMerchantPay/readme.md

@@ -10,6 +10,19 @@ Required minimum versions of Umbraco CMS:
 
 ## How To Use
 
+To get started with _emerchantpay_ a merchant would need to be onboarded in order to get a merchant ID and obtain the keys 
+required by the integration.
+
+To begin the onboarding process an obtain the merchant account, you would need to fill out [this](https://www.emerchantpay.com/contact-us?utm_source__c=umbraco_referral&utm_medium__c=technical_blog&utm_campaign__c=Umbraco) form.
+Afterwards, a member of the _emerchantpay_ team will reach out to you.
+
+### Customer journey map
+A merchant getting started with emerchantpay and Umbraco will need to make sure that they have an emerchantpay merchant account enabled and then cover these steps:
+
+* Package Installation
+* Site Settings
+* Workflow Setup
+
 ### Authentication
 
 All requests to emerchantpay API are authenticated by providing the merchant's username and password.
@@ -60,4 +73,4 @@ for payment sucessfully processed, failed or cancelled.
 When a form is submitted on the website, the workflow will execute and based on it's settings, two data payloads will be sent to emerchantpay for creating or retrieving the details of a consumer, and for creating a payment.
 The response for the second request will provide the URL for the hosted payment page, and the user will the redirected there. 
 
-On completing the payment the emerchantpay API will return the user to the page provided in matching event handler of the worklow.
+On completing the payment the emerchantpay API will return the user to the page provided in matching event handler of the worklow.