Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
fgiampietro committed Aug 15, 2023
1 parent ae99d29 commit 837b716
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
<img src="https://assets.monei.com/images/logo.svg" alt="MONEI" width="180">

Salesforce Commerce Cloud integration plugin
<h1>Salesforce Commerce Cloud MONEI link Cartridge</h1>
MONEI link cartridge for integrating the payment service with Salesforce Commerce Cloud (SFCC). This cartridge supports SFRA version 5.x.x & 6.x.x.

Instructions:
<h2>Requirements</h2>

It is required to have a MONEI account to use the cartridge, you can register <a href="https://dashboard.monei.com/settings">here</a>
If you have any questions or concerns, please visit https://support.monei.com/ and contact us

<h2>Useful pages</h2>

1. <a href="https://docs.monei.com/docs/">Technical documentation</a>
2. <a href="https://docs.monei.com/api/">API references</a>
3. <a href="https://docs.monei.com/docs/testing/">Testing documentation</a>

<h2>Basic cartridge installation instructions</h2>

1. Clone the repository
2. Insert the SFRA cartridges into the cartridge folder
3. If a new third-party cartridge is added, add it to .gitignore so as not to upload it to the repository
4. Modify the dw.json file with the user, pass and the corresponding version of code to be able to debug in the sandbox or synchronize the code.
2. Insert the int_monei_sfra cartridge into the cartridge folder
3. Unzip metadata_monei.zip and import the meta data required for the cartridge to work correctly
4. Run the build scripts (reference the Build section)
5. Modify the dw.json file with the user, pass and the corresponding version of code to be able to debug in the sandbox and synchronize the code
6. Check documentation/Integration_guide.docx for more integration details and configurations

<h2>Build</h2>

Run the command
<code>npm install</code>
for installing the required dependency packages

run the command
<code>npm run build</code>
for building the static resources required for the cartridge to work correctly

<h2>Licence</h2>

MIT license, see <a href="https://github.com/MONEI/MONEI-Salesforce-Commerce-Cloud/blob/main/LICENSE">LICENSE</a> section

0 comments on commit 837b716

Please sign in to comment.