From e79860ff403b73fab5cc58702bf3eea60b48d177 Mon Sep 17 00:00:00 2001 From: Sid Date: Wed, 25 Apr 2018 12:12:20 +1200 Subject: [PATCH] Added more info in README --- README.md | 34 ++++++++++++++++++++++++++++++++-- composer.json | 2 +- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d6a91a5..4c65789 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,38 @@ # php-data-tabulator -A PHP library to turn rows of data into aggregated tabular data format +A PHP library to turn rows of data (e.g.: from database query result) into aggregated tabular data format + +An example: + + $rows = [ + ['id' => 7, 'u_id' => 1, 'u_name' => 'Joan', 'a_id' => 'PK', 'a_name' => 'Packing', 'num' => 10.5, ], + ['id' => 4, 'u_id' => 1, 'u_name' => 'Joan', 'a_id' => 'PK', 'a_name' => 'Packing', 'num' => 0.5, ], + ['id' => 2, 'u_id' => 1, 'u_name' => 'Joan', 'a_id' => 'DR', 'a_name' => 'Driving', 'num' => 2.3, ], + ['id' => 5, 'u_id' => 2, 'u_name' => 'Robb', 'a_id' => 'DR', 'a_name' => 'Driving', 'num' => 8.7, ], + ]; + $tabulator = new DataTabulator($rows); + + $table = $tabulator->to2DTable('Name', 'u_id', 'u_name', 'a_id', 'a_name', 'num'); + + // Expected result ($table) is something like: + // + // Name Packing (PK) Driving (DR) + // Joan (1) 11 2.3 + // Robb (2) 0 8.7 + +## Installation + +### Library + + $ git clone https://github.com/onlinesid/php-data-tabulator.git + +### Dependencies + +#### [`Composer`](https://github.com/composer/composer) (*will use the Composer ClassLoader*) + + $ wget http://getcomposer.org/composer.phar + $ php composer.phar require onlinesid/php-data-tabulator:dev-master ## Running the tests $ php bin/phpunit - diff --git a/composer.json b/composer.json index 40e80a5..793fc5f 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "description": "A PHP library to transform rows into an aggregated table", "minimum-stability": "dev", "license": "MIT", - "version": "1.0.0", + "version": "1.0.1", "authors": [ { "name": "Sid Bachtiar",