Skip to content

Commit fd579ac

Browse files
deepakdebdeepakdeb
committed
readme and license added
1 parent a581f73 commit fd579ac

File tree

3 files changed

+110
-7
lines changed

3 files changed

+110
-7
lines changed

‎LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 PhpSpreadsheet Authors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
cbxjob
1+
CBX Career Dev Toolkit
22

3-
All possible default params:
3+
## Description
4+
This plugin provides command line interface for creating dummy job and resume.
45

5-
wp cbxjob-generate --total=100 --status=publish --is-remote=0
6+
# How to use:
7+
## cbxjob
8+
### All possible default params:
69

7-
--is-featured=1 --is-filled=0 --user-id=1 --salary-unit=monthly --currency=USD
10+
````
11+
wp cbxjob-generate --total=100 --status=publish --is-remote=0 --is-featured=1 --is-filled=0 --user-id=1 --salary-unit=monthly --currency=USD
12+
````
813

914

1015
total = number of jobs to be created.
@@ -24,10 +29,11 @@ salary-unit =[yearly,monthly,yearly,daily]
2429
user-id = user ID
2530

2631

27-
cbxresume
28-
32+
## cbxresume
33+
### All possible default params:
34+
````
2935
wp cbxjresume-generate --total=100 --user-id=1 --status=1 --privacy=public --is-primary=1
30-
36+
````
3137

3238
total = number of resume to be created.
3339

@@ -38,3 +44,7 @@ status = [0=draft, 1=publish, 2=unpublished, 3=pending, 4=flag]
3844
privacy= [public,private]
3945

4046
is-primary= [0,1]
47+
48+
## Licence
49+
50+
[MIT](https://github.com/codeboxrcodehub/cbxcareertoolkit/blob/master/LICENSE.txt)

‎README.txt

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
=== CBX Taxonomy Library ===
2+
Contributors: codeboxr, manchumahara
3+
Requires at least: 3.5
4+
Tested up to: 6.4.3
5+
Stable tag: 1.0.5
6+
License: MIT
7+
License URI: https://github.com/codeboxrcodehub/cbxphpspreadsheet/blob/master/LICENSE.txt
8+
9+
Open source PhpSpreadSheet php library released as wordpress plugin to use easily
10+
11+
== Description ==
12+
13+
A pure [PHP library for reading and writing spreadsheet files](https://phpspreadsheet.readthedocs.io)
14+
15+
From Codeboxr we wrapped the library as wordpress plugin to easy distribute as wordpress plugin. WordPress now doesn't allow this type library as
16+
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
17+
update easily.
18+
19+
Software requirements
20+
21+
The following software is required to develop using PhpSpreadsheet:
22+
23+
* PHP version 7.4 or newer
24+
* PHP extension php_zip enabled
25+
* PHP extension php_xml enabled
26+
* PHP extension php_gd2 enabled (if not compiled in)
27+
28+
29+
The plugin check php version, php_zip, php_xml and php_gd2 library compatible or installed or not, based on success it activated.
30+
31+
How to use:
32+
33+
`
34+
if ( defined('CBXPHPSPREADSHEET_PLUGIN_NAME') && file_exists( CBXPHPSPREADSHEET_ROOT_PATH . 'lib/vendor/autoload.php' ) ) {
35+
//Include PHPExcel
36+
require_once( CBXPHPSPREADSHEET_ROOT_PATH . 'lib/vendor/autoload.php' );
37+
38+
//now take instance
39+
$objPHPExcel = new \PhpOffice\PhpSpreadsheet\Spreadsheet();
40+
41+
//do whatever you need to do
42+
}
43+
`
44+
45+
== Installation ==
46+
47+
1. Download the latest zip from here (https://github.com/codeboxrcodehub/cbxphpspreadsheet/releases)
48+
2. [WordPress has clear documentation about how to install a plugin].(https://codex.wordpress.org/Managing_Plugins)
49+
3. After install activate the plugin "CBX PhpSpreadSheet Library" through the 'Plugins' menu in WordPress
50+
4. This plugin doesn't load any library by default, it doesn't create extra folder or menu.
51+
52+
53+
== Changelog ==
54+
55+
= 1.0.5 =
56+
* Dependency vendor packages updated to latest
57+
* Github.com based updater
58+
59+
= 1.0.4 =
60+
* Updated the phpspreadsheet package to latest V1.29.0
61+
62+
= 1.0.3 =
63+
* Updated the phpspreadsheet package to latest V1.21.0
64+
65+
= 1.0.2 =
66+
* Updated the phpspreadsheet package to latest V1.21.0
67+
68+
= 1.0.1 =
69+
* Updated the phpspreadsheet package to latest
70+
71+
= 1.0.0 =
72+
* First public release

0 commit comments

Comments
 (0)