lib/openspout/README.md

   1 # OpenSpout
   2
   3 [![Latest Stable Version](https://poser.pugx.org/openspout/openspout/v/stable)](https://packagist.org/packages/openspout/openspout)
   4 [![Total Downloads](https://poser.pugx.org/openspout/openspout/downloads)](https://packagist.org/packages/openspout/openspout)
   5 [![Build Status](https://github.com/openspout/openspout/actions/workflows/ci.yml/badge.svg)](https://github.com/openspout/openspout/actions/workflows/ci.yml)
   6 [![Infection MSI](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fopenspout%2Fopenspout%2F4.x)](https://dashboard.stryker-mutator.io/reports/github.com/openspout/openspout/4.x)
   7
   8 OpenSpout is a community driven fork of `box/spout`, a PHP library to read and write spreadsheet files
   9 (CSV, XLSX and ODS), in a fast and scalable way. Unlike other file readers or writers, it is capable of processing
  10 very large files, while keeping the memory usage really low (less than 3MB).
  11
  12 ## Documentation
  13
  14 Documentation can be found at [`docs/`](docs).
  15
  16 ## Upgrade from `box/spout:v3` to `openspout/openspout:v3`
  17
  18 1. Replace `box/spout` with `openspout/openspout` in your `composer.json`
  19 2. Replace `Box\Spout` with `OpenSpout` in your code
  20
  21 ## Upgrade guide
  22
  23 Version 4 introduced new functionality but also some breaking changes. If you want to upgrade your OpenSpout codebase
  24 please consult the [Upgrade guide](UPGRADE.md).
  25
  26 ## Copyright and License
  27
  28 This is a fork of Box's Spout library: https://github.com/box/spout
  29
  30 Code until and directly descending from commit [`cc42c1d`](https://github.com/openspout/openspout/commit/cc42c1d29fc5d29f07caeace99bd29dbb6d7c2f8)
  31 is copyright of _Box, Inc._ and licensed under the Apache License, Version 2.0:
  32
  33 https://github.com/openspout/openspout/blob/cc42c1d29fc5d29f07caeace99bd29dbb6d7c2f8/LICENSE
  34
  35 Code created, edited and released after the commit mentioned above
  36 is copyright of _openspout_ Github organization and licensed under MIT License.
  37
  38 https://github.com/openspout/openspout/blob/main/LICENSE