caxlsx 2.0.2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f41b32f0f196576b4a707597786ac9227f8f6f3c630754d1ec6dcec38137c3b
-  data.tar.gz: 8d000539c03e2ae7de7a2bd3d9610856abe77b26526e176ddc5e7460d062b98d
+  metadata.gz: a1add2e0fe915a49d02b64fe4df1aac62541f75ed27c97d0b418cdea137077c6
+  data.tar.gz: d334797649d8ea1382ff2809359b7455cbde69365ecf798de4a51f0cfce903ca
 SHA512:
-  metadata.gz: 3c3d57bec5dfdd911a3a052bfe42cdebe672b5f16b797ba43fa0d3dc906920532cc7ee5330aaab84f48112f3ed445c73de57546214cff71a30499d63a54bab81
-  data.tar.gz: 9bf3940c7dc4bdfcddee151ead1b0bf27b948e8fc0ba6c768ba966b81165446a0c0b0da581132018e75e019d665bdaaf4fe8eb055fb51174601b87320c8143be
+  metadata.gz: b164b9fe978fbc8866c3dbeea317c50d93c8b6796eeeb3a6b5214e9c11be439034543e1c1caaf9b4ddbf8a23713398a1bb4c6c207107a77b47353e183f59a226
+  data.tar.gz: c3b2eb3c86f0498ce1979bc3898a22baff4ca2e3eb0b9efe4751062fb2cb69ba6b0cfdce72c7366830627b5c912450303abceeb7ca81179781a4f865bd4d8186

data/CHANGELOG.md

@@ -1,14 +1,100 @@
 CHANGELOG
 ---------
-- **November.25.12**:1.3.4
+
+- **Unreleased**
+
+- **January.5.21**: 3.0.4
+  - [PR #72](https://github.com/caxlsx/caxlsx/pull/72) - Relax Ruby dependency to allow for Ruby 3. This required Travis to be upgraded from Ubuntu Trusty to Ubuntu Bionic. rbx-3 was dropped.
+  - [PR #71](https://github.com/caxlsx/caxlsx/pull/71) - Adds date type to validator so sheet.add_data_validation works with date type. Addresses [I #26](https://github.com/caxlsx/caxlsx/issues/26) - Date Data Validation not working
+  - [PR #70](https://github.com/caxlsx/caxlsx/pull/70) - Fix worksheet title length enforcement caused by switching from size to bytesize. Addresses [I #67](https://github.com/caxlsx/caxlsx/issues/67) - character length error in worksheet name when using Japanese, which was introduced by addressing [I #588](https://github.com/randym/axlsx/issues/588) in the old Axlsx repo. 
+
+
+- **December.7.20**: 3.0.3
+  - [PR #62](https://github.com/caxlsx/caxlsx/pull/62) - Fix edge cases in format detection for objects whose string representation made them look like numbers but the object didn’t respond to `#to_i` or `#to_f`.
+  - [PR #56](https://github.com/caxlsx/caxlsx/pull/56) - Add `zip_command` option to `#serialize` for faster serialization of large Excel files by using a zip binary
+  - [PR #54](https://github.com/caxlsx/caxlsx/pull/54) - Fix type detection for floats with out-of-rage exponents
+  - [I #67](https://github.com/caxlsx/caxlsx/issues/67) - Fix regression in worksheet name length enforcement: Some unicode characters were counted incorrectly, so that names that previously worked fine now stopped working. (This was introduced in 3.0.2)
+  
+- **July.16.20**: 3.0.2
+  - [I #51](https://github.com/caxlsx/caxlsx/issues/51) - Images do not import on Windows. IO read set explicitly to binary mode.
+  - [PR #53](https://github.com/caxlsx/caxlsx/pull/53) - Limit column width to 255. Maximum column width limit in MS Excel is 255 characters, see https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
+  - [PR #44](https://github.com/caxlsx/caxlsx/pull/44) - Improve cell autowidth calculations. Previously columns with undefined/auto width would tend to be just slightly too small for the content. This is because certain letters were being excluded from the width calculation because they were deemed not wide enough. We now treat all characters as equal width which helps ensure columns auto-widths are actually large enough for the content. This will gain us a very slight performance improvement because of we are no longer searching the string for specific characters.
+
+- **October.4.19**: 3.0.1
+  - Support for ruby versions limited to officially supported version (Ruby v2.3+)
+  - Updates to dependency gems, especially nokogiri and ruby-zip
+  - Fix Relationship.instances cache
+  - Autoload fix for Rails
+
+- **October.4.19**: 2.0.2
+  - Released as caxlsx, fork of axlsx
+  - Update ruby-zip dependency (fixes https://github.com/randym/axlsx/issues/536)
+
+- **September.17.19**: 3.0.0
+  - First release of caxlsx, fork of axlsx
+
+- **April.1.17**: 3.0.0-pre
+  - Support for ruby versions limited to officially supported version
+  - Updates to dependency gems, especially nokogiri and ruby-zip
+  - Patch options parsing for two cell anchor
+  - Remove support for depreciated worksheet members
+  - Added Cell#name so you you can quickly create a defined name for a single cell in your workbook.
+  - Added full book view and sheet state management. This means you can specify how the workbook renders as well as manage sheet visibility.
+  - Added smoothing management for line charts series
+
+- **September.12.13**: 2.0.1
+  - Unpinned rubyzip version
+
+- **September.12.13**: 2.0.0
+  - DROPPED support for ruby 1.8.7
+  - Altered readme to link to contributors
+  - Lots of improvements to make charts and relations more stable.
+  - Patched color param mutation.
+  - Data sourced for pivot tables can now come from other sheets.
+  - Altered image file extension comparisons to be case insensitive.
+  - Added control character sanitization to shared strings.
+  - Added page breaks. see examples/example.rb for an example.
+  - Bugfix: single to dual cell anchors for images now swap properly so you can set the end_at position during instantiation, in a block or directly on the image.
+  - Improved how we convert date/time to include the UTC offset when provided.
+  - Pinned rubyzip to 0.9.9 for those who are not ready to go up. Please note that release 2.0.1 and on will be using the 1.n.n series of rubyzip
+  - Bugfix: transposition of cells for Worksheet#cols now supports
+    incongruent column counts.counts
+  - Added space preservation for cell text. This will allow whitespace
+    in cell text both when using shared strings and when serializing
+    directly to the cell.
+
+- **April.24.13**: 1.3.6
+  - Fixed LibreOffice/OpenOffice issue to properly apply colors to lines
+    in charts.
+  - Added support for specifying between/notBetween formula in an array.
+    *thanks* straydogstudio!
+  - Added standard line chart support. *thanks* scambra
+  - Fixed straydogstudio's link in the README. *thanks* nogara!
+
+- **February.4.13**: 1.3.5
+  - converted vary_colors for chart data to instance variable with appropriate defulats for the various charts.
+  - Added trust_input method on Axlsx to instruct the serializer to skip HTML escaping. This will give you a tremendous performance boost,
+    Please be sure that you will never have <, >, etc in your content or the XML will be invalid.
+  - Rewrote cell serialization to improve performance
+  - Added iso_8601 type to support text based date and time management.
+  - Bug fix for relationship management in drawings when you add images
+    and charts to the same worksheet drawing.
+  - Added outline_level_rows and outline_level_columns to worksheet to simplify setting up outlining in the worksheet.
+  - Added support for pivot tables
+  - Added support for descrete border edge styles
+  - Improved validation of sheet names
+  - Added support for formula value caching so that iOS and OSX preview can show the proper values. See Cell.add_row and the formula_values option.
+
+- **November.25.12**: 1.3.4
   - Support for headers and footers for worksheets
   - bug fix: Properly escape hyperlink urls
   - Improvements in color_scale generation for conditional formatting
   - Improvements in autowidth calculation.
-- **November.8.12**:1.3.3
+
+- **November.8.12**: 1.3.3
   - Patched cell run styles for u and validation for family
 
-- **November.5.12**:1.3.2
+- **November.5.12**: 1.3.2
   - MASSIVE REFACTORING
   - Patch for apostrophes in worksheet names
   - added sheet_by_name for workbook so you can now find your worksheets
@@ -16,6 +102,7 @@ CHANGELOG
   - added insert_worksheet so you can now add a worksheet to an
     arbitrary position in the worksheets list.
   - reduced memory consumption for package parts post serialization
+
 - **September.30.12**: 1.3.1
   - Improved control character handling
   - Added stored auto filter values and date grouping items
@@ -24,29 +111,35 @@ CHANGELOG
     all the predefined table styles.
   - Improved style management for fonts so they merge undefined values
     from the initial master.
+
 - **September.8.12**: 1.2.3
   - enhance exponential float/bigdecimal values rendering as strings intead
     of 'numbers' in excel.
   - added support for :none option on chart axis labels
   - added support for paper_size option on worksheet.page_setup
+
 - **August.27.12**: 1.2.2
    - minor patch for auto-filters
    - minor documentation improvements.
+
 - **August.12.12**: 1.2.1
    - Add support for hyperlinks in worksheets
    - Fix example that was using old style cell merging with concact.
    - Fix bug that occurs when calculating the font_size for cells that use a user specified style which does not define sz
+
 - **August.5.12**: 1.2.0
    - rebuilt worksheet serialization to clean up the code base a bit.
    - added data labels for charts
    - added table header printing for each sheet via defined_name. This
      means that when you print your worksheet, the header rows show for every page
-- **July.??.12**: 1.1.9 release
+
+- **July.??.12**: 1.1.9
    - lots of code clean up for worksheet
    - added in data labels for pie charts, line charts and bar charts.
    - bugfix chard with data in a sheet that has a space in the name are
      now auto updating formula based values
-- **July.14.12**: 1.1.8 release
+
+- **July.14.12**: 1.1.8
    - added html entity encoding for sheet names. This allows you to use
      characters like '<' and '&' in your sheet names.
    - new - first round google docs interoperability
@@ -55,7 +148,8 @@ CHANGELOG
      to PDF from Libra Office
    - various readability improvements and work standardizing attribute
      names to snake_case. Aliases are provided for backward compatiblity 
-- **June.11.12**: 1.1.7 release
+
+- **June.11.12**: 1.1.7
    - fix chart rendering issue when label offset is specified as a
      percentage in serialization and ensure that formula are not stored
 in value caches
@@ -63,7 +157,8 @@ in value caches
    - Add title property to axis so you can lable the x/y/series axis for
      charts.
    - Add sheet views with panes
-- **May.30.12**: 1.1.6 release
+
+- **May.30.12**: 1.1.6
    - data protection with passwords for sheets
    - cell level input validators
    - added support for two cell anchors for images
@@ -73,14 +168,15 @@ in value caches
    - added ph (phonetics) and s (style) attributes for row.
    - resolved all warnings generating from this gem.
    - improved comment relationship management for multiple comments
-- **May.13.12**: 1.1.5 release
+
+- **May.13.12**: 1.1.5
    - MOAR print options! You can now specify paper size, orientation,
      fit to width, page margings and gridlines for printing.
    - Support for adding comments to your worksheets
    - bugfix for applying style to empty cells
    - bugfix for parsing formula with multiple '='
 
-- **May.3.12:**: 1.1.4 release
+- **May.3.12:**: 1.1.4
    - MOAR examples
    - added outline level for rows and columns
    - rebuild of numeric and axis data sources for charts
@@ -92,23 +188,23 @@ in value caches
    - Added support for specifying the color of data series in charts.
    - bugfix using add_cell on row mismanaged calls to update_column_info.
 
-- ** April.25.12:**: 1.1.3 release
+- ** April.25.12:**: 1.1.3
    - Primarily because I am stupid.....Updates to readme to properly report version, add in missing docs and restructure example directory.
 
-- ** April.25.12:**: 1.1.2 release
+- ** April.25.12:**: 1.1.2
    - Conditional Formatting completely implemented.
    - refactoring / documentation for Style#add_style
    - added in label rotation for chart axis labels
    - bugfix to properly assign style and type info to cells when only partial information is provided in the types/style option
 
-- ** April.18.12**: 1.1.1 release
+- ** April.18.12**: 1.1.1
    - bugfix for autowidth calculations across multiple rows
    - bugfix for dimension calculations with nil cells.
    - REMOVED RMAGICK dependency WOOT!
    - Update readme to show screenshot of gem output.
    - Cleanup benchmark and add benchmark rake task
 
-- ** April.3.12**: 1.1.0 release
+- ** April.3.12**: 1.1.0
    - bugfix patch name_to_indecies to properly handle extended ranges.
    - bugfix properly serialize chart title.
    - lower rake minimum requirement for 1.8.7 apps that don't want to move on to 0.9 NOTE this will be reverted for 2.0.0 with workbook parsing!
@@ -123,7 +219,7 @@ in value caches
    - Major (like 7x faster!) performance updates.
    - Gem now supports for JRuby 1.6.7, as well as experimental support for Rubinius
 
-- ** March.5.12**: 1.0.18 release
+- ** March.5.12**: 1.0.18
    https://github.com/randym/axlsx/compare/1.0.17...1.0.18
    - bugfix custom borders are not properly applied when using styles.add_style
    - interop worksheet names must be 31 characters or less or some versions of office complain about repairs
@@ -133,14 +229,14 @@ in value caches
    - added << alias for add_row
    - removed presetting of date1904 based on authoring platform. Now defaults to use 1900 epoch (date1904 = false)
 
-- ** February.14.12**: 1.0.17 release
+- ** February.14.12**: 1.0.17
    https://github.com/randym/axlsx/compare/1.0.16...1.0.17
    - Added in support for serializing to StringIO
    - Added in support for using shared strings table. This makes most of the features in axlsx interoperable with iWorks Numbers
    - Added in support for fixed column_widths
    - Removed unneeded dependencies on active-support and i18n
 
-- ** February.2.12**: 1.0.16 release
+- ** February.2.12**: 1.0.16
    https://github.com/randym/axlsx/compare/1.0.15...1.0.16
    - Bug fix for schema file locations when validating in rails
    - Added hyperlink to images
@@ -148,14 +244,14 @@ in value caches
    - removed whitespace/indentation from xml outputs
    - col_style now skips rows that do not contain cells at the column index
 
-- **January.6.12**: 1.0.15 release
+- **January.6.12**: 1.0.15
    https://github.com/randym/axlsx/compare/1.0.14...1.0.15
    - Bug fix add_style specified number formats must be explicity applied for libraOffice
    - performance improvements from ochko when creating cells with options.
    - Bug fix setting types=>[:n] when adding a row incorrectly determines the cell type to be string as the value is null during creation.
    - Release in preparation for password protection merge
 
-- **December.14.11**: 1.0.14 release
+- **December.14.11**: 1.0.14
    - Added support for merging cells
    - Added support for auto filters
    - Improved auto width calculations
@@ -164,14 +260,14 @@ in value caches
    - Added access to app and core package objects so you can set the creator and other properties of the package
    - The beginning of password protected xlsx files - roadmapped for January release.
 
-- **December.8.11**: 1.0.13 release
+- **December.8.11**: 1.0.13
    -  Fixing .gemspec errors that caused gem to miss the lib directory. Sorry about that.
 
-- **December.7.11**: 1.0.12 release
+- **December.7.11**: 1.0.12
     DO NOT USE THIS VERSION = THE GEM IS BROKEN
   - changed dependency from 'zip' gem to 'rubyzip' and added conditional code to force binary encoding to resolve issue with excel 2011
   - Patched bug in app.xml that would ignore user specified properties.
-- **December.5.11**: 1.0.11 release
+- **December.5.11**: 1.0.11
   - Added [] methods to worksheet and workbook to provide name based access to cells.
   - Added support for functions as cell values
   - Updated color creation so that two character shorthand values can be used like 'FF' for 'FFFFFFFF' or 'D8' for 'FFD8D8D8'
@@ -179,7 +275,7 @@ in value caches
   - Clean up and support for 1.9.2 and travis integration
   - Added support for string based cell referencing to chart start_at and end_at. That means you can now use :start_at=>"A1" when using worksheet.add_chart, or chart.start_at ="A1" in addition to passing a cell or the x, y coordinates.
 
-- **October.30.11**: 1.0.10 release
+- **October.30.11**: 1.0.10
   - Updating gemspec to lower gem version requirements.
   - Added row.style assignation for updating the cell style for an entire row
   - Added col_style method to worksheet upate a the style for a column of cells
@@ -189,11 +285,11 @@ in value caches
   - fixed out of range bug in time calculations for 32bit time.
   - added i18n for active support
 
-- **October.26.11**: 1.0.9 release
+- **October.26.11**: 1.0.9
   - Updated to support ruby 1.9.3
   - Updated to eliminate all warnings originating in this gem
 
-- **October.23.11**: 1.0.8 release
+- **October.23.11**: 1.0.8
   - Added support for images (jpg, gif, png) in worksheets.
 
 - **October.23.11**: 1.0.7 released
@@ -207,10 +303,10 @@ in value caches
   - rebuild of anchor positioning to remove some spagetti code. Chart now supports a start_at and end_at method that accept an arrar for col/row positioning. See example6 for an example. You can still pass :start_at and :end_at options to worksheet.add_chart.
   - Refactored cat and val axis data to keep series serialization a bit more DRY
 
-##October.22.11: 1.0.6 release
+- **October.22.11**: 1.0.6
   - Bumping version to include docs. Bug in gemspec pointing to incorrect directory.
 
-##October.22.11: 1.05
+- **October.22.11**: 1.05
   - Added support for line charts
   - Updated examples and readme
   - Updated series title to be a real title ** NOTE ** If you are accessing titles directly you will need to update text assignation.
@@ -226,14 +322,13 @@ in value caches
   - Added style property to charts
   - Removed serialization write test as it most commonly fails when run from the gem's intalled directory
 
-##October.21.11: 1.0.4
+- **October.21.11**: 1.0.4
   - altered package to accept a filename string for serialization instead of a File object.
   - Updated specs to conform
   - More examples for readme
 
 
-##October.21.11: 1.0.3 release
+- **October.21.11**: 1.0.3
   - Updated documentation
 
-##October.20.11: 0.1.0 release
-
+- **October.20.11**: 0.1.0

data/README.md

@@ -1,84 +1,35 @@
-Axlsx: Office Open XML Spreadsheet Generation
-====================================
-[![Build Status](https://secure.travis-ci.org/randym/axlsx.png?branch=master)](http://travis-ci.org/randym/axlsx/)
+# Caxlsx (Community Continued Version)
+[![Build Status](https://travis-ci.com/caxlsx/caxlsx.svg?branch=master)](https://travis-ci.com/caxlsx/caxlsx)
+[![Gem
+Version](https://badge.fury.io/rb/caxlsx.svg)](http://badge.fury.io/rb/caxlsx)
 
-If you are using axlsx for comercial purposes, or just want to show your
-appreciation for the gem, please don't hesitate to make a donation.
+## Notice: Community Axlsx Organization
 
-[![Click here to lend your support to: axlsx and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/17814.png?skin_name=chrome)](http://www.pledgie.com/campaigns/17814)
+To better maintain the Axlsx ecosystem, all related gems have been forked or moved to the following community organization: 
 
-**IRC**:[irc.freenode.net / #axlsx](irc://irc.freenode.net/axlsx)
+http://github.com/caxlsx
 
-**Git**:[http://github.com/randym/axlsx](http://github.com/randym/axlsx)
+[Join the Caxlsx Slack channel](https://join.slack.com/t/caxlsx/shared_invite/enQtOTI5OTM0MzI1Njk5LTBlMDQzNDk2YzkwODMxMmVkODMyYzJiZGU5NTQ3YTg5NTBlN2IwZTlmNTRjNzhiY2E0MDY2OTEyYmFlODI5NjA)
 
-**Twitter**: [https://twitter.com/#!/morgan_randy](https://twitter.com/#!/morgan_randy)
-
-**Google Group**: [https://groups.google.com/forum/?fromgroups#!forum/axlsx](https://groups.google.com/forum/?fromgroups#!forum/axlsx)
-
-**Author**: Randy Morgan
-
-**Copyright**: 2011 - 2013
-
-**License**: MIT License
-
-**Latest Version**: 2.0.1
-
-**Ruby Version**: 1.9.2, 1.9.3, 2.0.0
-
-**JRuby Version**: 1.9 modes
-
-**Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
-
-**Release Date**: September 12th 2013
-
-If you are working in rails, or with active record see:
-[acts_as_xlsx](http://github.com/randym/acts_as_xlsx)
-
-acts_as_xlsx is a simple ActiveRecord mixin that lets you generate a workbook with:
-
-```ruby
-Posts.where(created_at > Time.now-30.days).to_xlsx
-```
-
-** and **
-
-* http://github.com/straydogstudio/axlsx_rails
-Axlsx_Rails provides an Axlsx renderer so you can move all your spreadsheet code from your controller into view files. Partials are supported so you can organize any code into reusable chunks (e.g. cover sheets, common styling, etc.) You can use it with acts_as_xlsx, placing the to_xlsx call in a view and add ':package => xlsx_package' to the parameter list. Now you can keep your controllers thin!
-
-There are guides for using axlsx and acts_as_xlsx here:
-[http://axlsx.blog.randym.net](http://axlsx.blog.randym.net)
-
-If you are working with ActiveAdmin see:
-
-[activeadmin_axlsx](http://github.com/randym/activeadmin_axlsx)
-
-It provies a plugin and dsl for generating downloadable reports.
-
-The examples directory contains a number of more specific examples as
-well.
-
-Synopsis
---------
+## Synopsis
 
 Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language.
 With Axlsx you can create excel worksheets with charts, images (with links), automated and fixed column widths, customized styles, functions, tables, conditional formatting, print options, comments, merged cells, auto filters, file and stream serialization  as well as full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification.
 
-![Screen 1](https://github.com/randym/axlsx/raw/master/examples/sample.png)
-
+![Screen 1](https://github.com/caxlsx/caxlsx/raw/master/examples/sample.png)
 
 
-Feature List
-------------
+## Feature List
 
-1. Author xlsx documents: Axlsx is made to let you easily and quickly generate professional xlsx based reports that can be validated before serialization.
+1. Author xlsx documents: Caxlsx is made to let you easily and quickly generate professional xlsx based reports that can be validated before serialization.
 
-2. Generate 3D Pie, Line, Scatter and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all. Customize gridlines, label rotation and series colors as well.
+2. Generate 3D Pie, Line, Scatter and Bar Charts: With Caxlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all. Customize gridlines, label rotation and series colors as well.
 
 3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.
 
-4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String, Date, Time and Boolean types are automatically identified and serialized to your spreadsheet.
+4. Automatic type support: Caxlsx will automatically determine the type of data you are generating. In this release Float, Integer, String, Date, Time and Boolean types are automatically identified and serialized to your spreadsheet.
 
-5. Automatic and fixed column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet, or use any value you specify for the really funky stuff.
+5. Automatic and fixed column widths: Caxlsx will automatically determine the appropriate width for your columns based on the content in the worksheet, or use any value you specify for the really funky stuff.
 
 6. Support for automatically formatted 1904 and 1900 epochs configurable in the workbook.
 
@@ -114,18 +65,14 @@ and Numbers
 
 22. Page Breaks
 
-Installing
-----------
 
-To install Axlsx, use the following command:
+## Install
 
-    $ gem install axlsx
-
-#Examples
-------
+```ruby
+gem 'caxlsx'
+```
 
-The example listing is getting overly large to maintain here.
-If you are using Yard, you will be able to see the examples in line below.
+## Usage
 
 Here's a teaser that kicks about 2% of what the gem can do.
 
@@ -142,72 +89,40 @@ Axlsx::Package.new do |p|
 end
 ```
 
-Please see the [examples](https://github.com/randym/axlsx/tree/master/examples/example.rb) for more.
-
-{include:file:examples/example.rb}
-
-There is much, much more you can do with this gem. If you get stuck, grab me on IRC or submit an issue to GitHub. Chances are that it has already been implemented. If it hasn't - let's take a look at adding it in.
-
-#Documentation
---------------
-
-This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
-
-     gem install yard
-
-     yard server -g
-
-#Specs
-------
-
-This gem has 100% test coverage using test/unit. To execute tests for this gem, simply run rake in the gem directory.
-
-#Change log
----------
-
-- **September.12.13**:2.0.1
-  - Unpinned rubyzip version
-- **September.12.13**:2.0.0
-  - DROPPED support for ruby 1.8.7
-  - Altered readme to link to contributors
-  - Lots of improvements to make charts and relations more stable.
-  - Patched color param mutation.
-  - Data sourced for pivot tables can now come from other sheets.
-  - Altered image file extension comparisons to be case insensitive.
-  - Added control character sanitization to shared strings.
-  - Added page breaks. see examples/example.rb for an example.
-  - Bugfix: single to dual cell anchors for images now swap properly so you can set the end_at position during instantiation, in a block or directly on the image.
-  - Improved how we convert date/time to include the UTC offset when provided.
-  - Pinned rubyzip to 0.9.9 for those who are not ready to go up. Please note that release 2.0.1 and on will be using the 1.n.n series of rubyzip
-  - Bugfix: transposition of cells for Worksheet#cols now supports
-    incongruent column counts.counts
-  - Added space preservation for cell text. This will allow whitespace
-    in cell text both when using shared strings and when serializing
-    directly to the cell.
-- **April.24.13**:1.3.6
-  - Fixed LibreOffice/OpenOffice issue to properly apply colors to lines
-    in charts.
-  - Added support for specifying between/notBetween formula in an array.
-    *thanks* straydogstudio!
-  - Added standard line chart support. *thanks* scambra
-  - Fixed straydogstudio's link in the README. *thanks* nogara!
-- **February.4.13**:1.3.5
-  - converted vary_colors for chart data to instance variable with appropriate defulats for the various charts.
-  - Added trust_input method on Axlsx to instruct the serializer to skip HTML escaping. This will give you a tremendous performance boost,
-    Please be sure that you will never have <, >, etc in your content or the XML will be invalid.
-  - Rewrote cell serialization to improve performance
-  - Added iso_8601 type to support text based date and time management.
-  - Bug fix for relationahip management in drawings when you add images
-    and charts to the same worksheet drawing.
-  - Added outline_level_rows and outline_level_columns to worksheet to simplify setting up outlining in the worksheet.
-  - Added support for pivot tables
-  - Added support for descrete border edge styles
-  - Improved validation of sheet names
-  - Added support for formula value caching so that iOS and OSX preview can show the proper values. See Cell.add_row and the formula_values option.
-
-Please see the {file:CHANGELOG.md} document for past release information.
-
-# Known interoperability issues.
+Please see the [examples folder](https://github.com/caxlsx/caxlsx/tree/master/examples) for further information on what you can do with this gem  Chances are that it has already been implemented. If it hasn't, let's take a look at adding it in.
+
+## Documentation
+
+Detailed documentation is available at:
+
+[https://www.rubydoc.info/gems/caxlsx/](https://www.rubydoc.info/gems/caxlsx/)
+
+Additional documentation is listed below:
+
+- [Examples](https://github.com/caxlsx/caxlsx/tree/master/examples)
+- [FAQ](https://github.com/caxlsx/caxlsx/wiki/FAQ) (work in progress)
+- [Style Reference](https://github.com/caxlsx/caxlsx/blob/master/docs/style_reference.md)
+- [Header and Footer Codes](https://github.com/caxlsx/caxlsx/blob/master/docs/header_and_footer_codes.md)
+
+⚠ Please __do not create issues__ for questions regarding the usage of axlsx / caxlsx. Look through this README, the [examples](https://github.com/caxlsx/caxlsx/tree/master/examples/example.rb), and the [FAQ](https://github.com/caxlsx/caxlsx/wiki/FAQ), and also check [questions tagged `axlsx` on Stack Overflow](https://stackoverflow.com/questions/tagged/axlsx).
+
+Feel free to add your question (including an answer!) to the FAQ if you think it is of general interest.
+
+## Plugins, Integrations, and Extensions
+
+Currently the following additional gems are available:
+
+- [acts_as_caxlsx](https://github.com/caxlsx/acts_as_caxlsx)
+  * Provides simple ActiveRecord integration
+- [caxlsx_rails](https://github.com/caxlsx/caxlsx_rails)
+  * Provides a `.axlsx` renderer to Rails so you can move all your spreadsheet code from your controller into view files.
+- [activeadmin-caxlsx](https://github.com/caxlsx/activeadmin-caxlsx)
+  * An Active Admin plugin that includes DSL to create downloadable reports.
+- [axlsx_styler](https://github.com/axlsx-styler-gem/axlsx_styler)
+  * Allows you to build clean and maintainable styles for your axlsx spreadsheets. Build your spreadsheeet with data and then apply styles later.
+
+## Known Software Interoperability Issues
+
 As axslx implements the Office Open XML (ECMA-376 spec) much of the
 functionality is interoperable with other spreadsheet software. Below is
 a listing of some known issues.
@@ -224,9 +139,9 @@ related to themes, which axlsx does not implement at this time.
    - Images are known to not work with google docs
    - border colors do not work
 
-3. Numbers
-   - you must set 'use_shared_strings' to true. This is most
-     conveniently done just before rendering by calling Package.use_shared_strings = true prior to serialization.
+3. Apple Numbers
+   - charts do not render
+   - you must set 'use_shared_strings' to true. This is most conveniently done just before rendering by calling Package.use_shared_strings = true prior to serialization.
 
 ```ruby
 p = Axlsx::Package.new
@@ -238,19 +153,18 @@ p.use_shared_strings = true
 p.serialize('simple.xlsx')
 ```
 
-   - charts do not render
+## Known Bugs
 
+There’s a [list of known bugs](https://github.com/caxlsx/caxlsx/issues?q=label%3A%22known+bug%22). (If you want to contribute to caxlsx, this is a good place to start!)
 
-#Thanks!
+## Contributing
 
-Open source software is a community effort. None of this could have been
-done without the help of these awesome folks.
+See [CONTRIBUTING.md](https://github.com/caxlsx/caxlsx/blob/master/CONTRIBUTING.md)
 
-[contributors](https://github.com/randym/axlsx/graphs/contributors)
+## Credits
 
-#Copyright and License
-----------
+Originally created by Randy Morgan - @randym
 
-Axlsx &copy; 2011-2013 by [Randy Morgan](mailto:digial.ipseity@gmail.com).
+Forked in 2019, to enable the community to maintain the Axlsx ecosystem - http://github.com/caxlsx
 
-Axlsx is licensed under the MIT license. Please see the LICENSE document for more information.
+Open source software is a community effort. None of this could have been done without the help of [our Contributors](https://github.com/caxlsx/caxlsx/graphs/contributors).