summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnthony Lindsay2012-08-24 09:40:36 (GMT)
committerAnthony Lindsay2012-08-24 09:40:36 (GMT)
commitbbd79d9d4bd2b9c91c4a8b818bd5cb49302e2d09 (patch)
treea3a02fc841b57286fa524633d3e512724dbcb573
parenta0a8ea35cd9e7458997b221a4bd3d3f5be62e651 (diff)
Added a (hopefully) properly named readme.txt.
-rw-r--r--README.txt30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..16f89eb
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,30 @@
+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
+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
+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
+is a block, you can use Context to control positioning.
+
+All the settings are stored in the Variable table and are prepended by the
+module name.
+
+Installation:
+
+Install Views
+Install Commerce
+Install Commerce Popular Products
+Place the block wherever you want it
+Set up your products & product displays.
+Customize the view as you see fit.
+The default settings are sensible, but if you want them they live at
+admin/commerce/config/popular-products.