Add Readme.md to repository

README.md

@@ -1,19 +1,35 @@
-#Meanbee_BestSellerSort
-
+Meanbee Best Seller Sort Extension
+=====================
 Meanbee BestSellerSort adds the ability for you to sort your products by Best Sellers over a period of time, default is 30 days, allow you to keep on promoting the best products to your customers and making them much easier to find in your listings.
 
-###Features:
+Features
+-------
+Add new sort option to category pages, allowing customers to see the best selling products.
+Best sellers is generated automatically, and recalculated each day to keep the data relevant. No manual work needed!
+Putting your best selling products towards the top of the category will help your customers find the best products, the ones they are most likely to buy! The result? Increased conversions and sales.
+
+How to customise
+-------
+The date range this module uses can be configured by you, allowing you to define the exact number previous days sales that should be used when calculating the best seller positioning.
+
+Under System > Configuration > Catalog > Meanbee: Best Seller Sort you will see two configuration options. The first allows you to re-calculate the best sellers manually (this happens automatically each night, but you may wish to recalculate sooner). The second allows you define the number of days used in the best seller calculation.
 
-- Add new sort option to category pages, allowing customers to see the best selling products.
-- Best sellers is generated automatically, and recalculated each day to keep the data relevant. No manual work needed!
-- Putting your best selling products towards the top of the category will help your customers find the best products, the ones they are most likely to buy! The result? Increased conversions and sales.
+##### Compatibility
+ Compatibility: 1.6, 1.7, 1.8, 1.9
 
-###How to customise:
+Support
+-------
+You are welcome to log any issues you find for community support but the functionality is provided *as is* and we will not be providing support. We will however review pull requests if you provide one.
 
-The date range this module uses can be configured by you, allowing you to define the exact number previous days sales that should be used when calculating the best seller positioning. 
+Contribution
+------------
+Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
 
-Under `System > Configuration > Catalog > Meanbee: Best Seller Sort` you will see two configuration options. The first allows you to re-calculate the best sellers manually (this happens automatically each night, but you may wish to recalculate sooner). The second allows you define the number of days used in the best seller calculation.
 
-###Release History
+Licence
+-------
+[OSL - Open Software Licence 3.0](http://opensource.org/licenses/osl-3.0.php)
 
-- V1.0.0 - Initial Release
+Copyright
+---------
+(c) 2017 Meanbee