From a54dffa40e389ff016c0be6cdcf1566ce3d34190 Mon Sep 17 00:00:00 2001
From: EnasAsmar <101696859+EnasAsmar@users.noreply.github.com>
Date: Thu, 13 Jul 2023 03:05:32 +0300
Subject: [PATCH] Update README.md
---
README.md | 121 ++++++++++++++++++++++++++++++++++--------------------
1 file changed, 77 insertions(+), 44 deletions(-)
diff --git a/README.md b/README.md
index 67b3a41..0eb31b5 100644
--- a/README.md
+++ b/README.md
@@ -1,69 +1,102 @@
+# Corals Amazon
+Amazon Module is an addon for Laraship eCommerce that gives you the ability to import products from Amazon and sell them as affiliate products, you can filter products by keywords and categories with other importing options. the import will extract the following:
-[
](https://supportukrainenow.org)
+1.Product Attributes: title, description, price, Amazon URL, and ASIN
-# :package_description
+2.the reviews iframe
-[](https://packagist.org/packages/:vendor_slug/:package_slug)
-[](https://github.com/:vendor_slug/:package_slug/actions/workflows/run-tests.yml)
-[](https://packagist.org/packages/:vendor_slug/:package_slug)
-
----
-This package can be used as to scaffold a framework agnostic package. Follow these steps to get started:
+3.Product Images
-1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
-3. Have fun creating your package.
-4. If you need help creating a package, consider picking up our Laravel Package Training video course.
----
-
-This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example.
+4.Brand
-## Support us
+5.Categories
-[
](https://spatie.be/github-ad-click/:package_name)
+6.Tags
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+Amazon Module Manager is using Product Advertising API to connect to Amazon to pull the products from Amazon.
-## Installation
+p>
-You can install the package via composer:
+### How To Get Your Access Key ID & Secret Key
+Getting your Access Key ID and Secret Key pair is easy enough, but it involves a number of steps.
-```bash
-composer require :vendor_slug/:package_slug
-```
+1) Goto the Amazon Associates Program home page and login to your account. For the purposes of this tutorial, we assume you are already an approved Amazon affiliate.
-## Usage
+https://affiliate-program.amazon.com
-```php
-$skeleton = new VendorName\Skeleton();
-echo $skeleton->echoPhrase('Hello, VendorName!');
-```
+2) Click on the Product Advertising API link at the top of the page:
-## Testing
-```bash
-composer test
-```
+
+
+
+3) Click the button to access/signup. Log in to your Amazon login or follow the prompts to create your Product Advertising API account.
+
+
+p>
+
+4) If you get a prompt on the next screen, click on Continue to Security Credentials. DO NOT USE IAM USERS – Amazon’s Product Advertising API must use the parent keys, not user keys.
+
+
+
+p>
+
+5) Expand the “Access Keys” section. This section contains all of your current access keys. You will likely need to make a new one (you can have 2 active key pairs per account). Feel free to use an existing one if you have the secret key already, otherwise click on the Create New Access Key button.
+
+
+
+p>
+
+6) A dialog box will appear with your new Access Key and Secret Key. Copy these into the ThirstyAffiliates->Settings page under the Amazon Importer settings tab.
+
+We also recommend clicking the Download Key File button and storing this in a secure location, like a password manager as you cannot retrieve the Secret Key from an existing Access Key after you click Close. Make sure you have it otherwise you will need to de-activate an old key and create another new one.
-## Changelog
+p>
+
+p>
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+Your keys should look something like this:
-## Contributing
+- Access key ID example: AKIAIOSFODNN7EXAMPLE
-Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
+- Secret access key example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
-## Security Vulnerabilities
+p>
-Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+### How To Get Your Amazon Associate Tag
+The associate tag can be found under your amazon affiliate at the top right, as in the screenshot below
-## Credits
+
+p>
-- [:author_name](https://github.com/:author_username)
-- [All Contributors](../../contributors)
-## License
+### Now You can enter all these details to Amazon Plugin settings.
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+p>
+
+
+### Setup Your Cron Job:
+Amazon Importer uses background processes extract imports to avoid any timeout memory issues, jobs will be queued and the importer process will import only one job at the time, to set up your importer scheduler you need to add the following command to your crontab
+
+```php
+php artisan import:run
+```
+
+
+
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require corals/amazon
+```
+
+## Testing
+
+```bash
+vendor/bin/phpunit vendor/corals/amazon/tests
+```