Skip to content

Commit 2ee658f

Browse files
committed
added readme file
1 parent e8012f2 commit 2ee658f

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.txt

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
=== CBX PhpSpreadSheet Library ===
2+
Contributors: codeboxr,manchumahara
3+
Donate link: https://codeboxr.com
4+
Requires at least: 3.5
5+
Tested up to: 5.2
6+
Stable tag: 1.0.0
7+
License: GPLv2 or later
8+
License URI: http://www.gnu.org/licenses/gpl-2.0.html
9+
10+
Open source PhpSpreadSheet php library released as wordpress plugin to use easily
11+
12+
== Description ==
13+
14+
A pure [PHP library for reading and writing spreadsheet files](https://phpspreadsheet.readthedocs.io)
15+
16+
From Codeboxr we wrapped the library as wordpress plugin to easy distribute as wordpress plugin. WordPress now doesn't allow this type library as
17+
plugin but providing a large php package with plugin makes the plugin heavy and troublesome for updates. We hosted this in github so that user can download and later
18+
update easily.
19+
20+
Software requirements
21+
22+
The following software is required to develop using PhpSpreadsheet:
23+
24+
* PHP version 5.6 or newer
25+
* PHP extension php_zip enabled
26+
* PHP extension php_xml enabled
27+
* PHP extension php_gd2 enabled (if not compiled in)
28+
29+
30+
The plugin check php version, php_zip, php_xml and php_gd2 library compatible or installed or not, based on success it activated.
31+
32+
How to use:
33+
34+
`
35+
if ( defined('CBXPHPSPREADSHEET_PLUGIN_NAME') && file_exists( CBXPHPSPREADSHEET_ROOT_PATH . 'lib/vendor/autoload.php' ) ) {
36+
//Include PHPExcel
37+
require_once( CBXPHPSPREADSHEET_ROOT_PATH . 'lib/vendor/autoload.php' );
38+
39+
//now take instance
40+
$objPHPExcel = new \PhpOffice\PhpSpreadsheet\Spreadsheet();
41+
42+
//do whatever you need todo
43+
}
44+
`
45+
46+
== Installation ==
47+
48+
1. Download the latest zip from here (https://github.com/codeboxrcodehub/cbxphpspreadsheet/releases)
49+
2. [WordPress has clear documentation about how to install a plugin].(https://codex.wordpress.org/Managing_Plugins)
50+
3. After install activate the plugin "CBX PhpSpreadSheet Library" through the 'Plugins' menu in WordPress
51+
4. This plugin doesn't load any library by default, it doesn't create extra folder or menu.
52+
53+
54+
55+
56+
57+
== Screenshots ==
58+
59+
1. yet to come
60+
61+
== Changelog ==
62+
63+
= 1.0 =
64+
* First public release

0 commit comments

Comments
 (0)