summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnthony Lindsay2014-09-29 08:09:33 (GMT)
committerAnthony Lindsay2014-09-29 08:09:33 (GMT)
commitdb3dc79121a20be834f10d1c3564c7b7b8aab245 (patch)
treeb21620614a392019d73c3b102f33a0266e8a1877
parent1d4c3417801e482302d039901d19ebb3b4d105b6 (diff)
Added documentation to explain when order data is generated.
-rw-r--r--README.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.txt b/README.txt
index 1c46d1e..4464283 100644
--- a/README.txt
+++ b/README.txt
@@ -2,20 +2,22 @@ Commerce Popular Products
+++++++++++++++++++++++++++
Commerce Popular Projects looks through your Drupal Commerce orders and figures
-out the most popular products for a given timeframe. You can include/exclude
-product node types, set the timeframe for your popularity ranking and calls a
+out the most popular products for a given timeframe. You can include/exclude
+product node types, set the timeframe for your popularity ranking and calls a
View to display your Commerce products.
The settings screen is found in the main Commerce store settings.
-Popular products are displayed using a View which pulls in title only by
+Popular products are displayed using a View which pulls in title only by
default. The View can be overridden through the Views UI. The View is displayed
-in a block.
-On install the module attempts to place the block in the main content area, but
-if it cannot, you must set the block location manually. Obviously, because it
+in a block.
+On install the module attempts to place the block in the main content area, but
+if it cannot, you must set the block location manually. Obviously, because it
is a block, you can use Context to control positioning.
-All the settings are stored in the Variable table and are prepended by the
+When the block is viewed, the module attempts to retrieve cached data about product popularity. If no cached data is available, it generates data, keeping its calculations within the timeframe as defined by the module settings, e.g. the last month. In parallel to this, the data is refreshed every time a customer completes checkout.
+
+All the settings are stored in the Variable table and are prepended by the
module name.
Installation: