Merge pull request #22 from keboola/renovation

Renovation

Author: odinuv

.codeclimate.yml

@@ -0,0 +1,11 @@
+version: "2"
+plugins:
+  phpmd:
+    enabled: true
+  phpcodesniffer:
+    enabled: true
+  sonar-php:
+    enabled: true
+    checks:
+      php:S1117:
+        enabled: false

.travis.yml

@@ -1,9 +1,9 @@
 language: php
 before_script: composer install
 php:
-  - 5.4
-  - 5.5
-  - 5.6
-  - 7.0
-  - hhvm
-
+- 5.6
+- 7.0
+- hhvm
+notifications:
+  slack:
+    secure: WVnUU0fkZS75md3mm7B08SxhP3HDeHbJ8GTPR1DUVjK3MHAmKeSah/plNNxn9I/TdlXnHzQO5WBN33nUq0ODGGT4WFzFa66YTX2tb+bNSmewBOv82hEoITTI1PI9SLq0WNtcamHWCM3Rt1XtiZb3DQk/OcUfiWrrn74q4PPX+VY=

CHANGELOG.md

@@ -1,2 +1,11 @@
+## 2.0.0
+ * [Refactor] No support for PHP < 5.6  
+
+## 1.2.0
+ * [Feat] Add option to skip lines (header) when reading
+
+## 1.1.4
+ * [Feat] Throw exception if non-scalar data is written
+
 ## 1.1.3
- * [Bugfix] Throw exception on file write error
+ * [Bugfix] Throw exception on file write error

README.md

@@ -2,6 +2,12 @@
 [![Latest Stable Version](https://poser.pugx.org/keboola/csv/v/stable.svg)](https://packagist.org/packages/keboola/csv)
 [![License](https://poser.pugx.org/keboola/csv/license.svg)](https://packagist.org/packages/keboola/csv)
 [![Total Downloads](https://poser.pugx.org/keboola/csv/downloads.svg)](https://packagist.org/packages/keboola/csv)
+[![Maintainability](https://api.codeclimate.com/v1/badges/869a0ab5c1d228279ab0/maintainability)](https://codeclimate.com/github/keboola/php-csv/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/869a0ab5c1d228279ab0/test_coverage)](https://codeclimate.com/github/keboola/php-csv/test_coverage)
+
+The library provides a simple reader and writer for CSV files according to [RFC4180](https://tools.ietf.org/html/rfc4180). 
+The library is licensed under the [MIT](https://github.com/keboola/php-csv/blob/master/LICENSE) license. The library provides 
+a single `CsvFile` class for both reading and writing CSV files. The class is designed to be **immutable** and minimalistic.
 
 ## Usage
 
@@ -14,6 +20,19 @@ foreach($csvFile as $row) {
 }
 ```
 
+#### Skip lines
+Skip the first two lines:
+
+```php
+use Keboola\Csv\CsvFile;
+$filename = __DIR__ . '/_data/test-input.csv';
+$csvFile = new \Keboola\Csv\CsvFile($fileName, CsvFile::DEFAULT_DELIMITER, CsvFile::DEFAULT_ENCLOSURE, CsvFile::DEFAULT_ENCLOSURE, 2)
+foreach($csvFile as $row) {
+	var_dump($row);
+}
+```
+      
+
 ### Write CSV
 
 ```php
@@ -34,31 +53,13 @@ foreach ($rows as $row) {
 
 ## Installation
 
-Library is available as composer package.
-To start using composer in your project follow these steps:
-
-**Install composer**
-
-```bash
-curl -s http://getcomposer.org/installer | php
-mv ./composer.phar ~/bin/composer # or /usr/local/bin/composer
-```
-
-**Create composer.json file in your project root folder:**
-
-```json
-{
-    "require": {
-        "php" : ">=5.3.2",
-        "keboola/csv": "1.1.*"
-    }
-}
-```
+The library is available as [composer package](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx). 
+To start using this library in your project follow these steps:
 
 **Install package:**
 
 ```bash
-composer install
+composer require keboola/csv
 ```