Skip to content

Commit 09e8364

Browse files
authored
Update README.md
1 parent a9a400f commit 09e8364

1 file changed

Lines changed: 36 additions & 5 deletions

File tree

README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,40 @@
1-
# Examples using KoolReport framework
2-
These examples demonstrate KoolReport framework's and its packages' abilities.
1+
# KoolReport's Examples
32

4-
[KoolReport Homepage](https://www.koolreport.com/).
3+
These examples demonstrate the usage of KoolReport Framework and its extended packages.
54

6-
For an online version of the examples, please visit [KoolReport Examples](https://www.koolreport.com/examples/).
5+
# About KoolReport
6+
7+
KoolReport is an intuitive and flexible Open-Source PHP Reporting Framework for faster and easier report delivery. It gives you full control of data process as well as data visualization. It is fast, simple and can be extended in many ways.
8+
9+
KoolReport is free and open source released under MIT license.
10+
11+
* Website: [https://www.koolreport.com](https://www.koolreport.com/)
12+
* Documentation: [https://www.koolreport.com/docs](https://www.koolreport.com/docs)
13+
* Online Examples: [https://www.koolreport.com/examples](https://www.koolreport.com/examples/)
14+
15+
# How to install example
16+
17+
Please make the folder structure like this:
18+
19+
```
20+
/
21+
├── koolreport/
22+
└── koolreport-examples/
23+
```
24+
25+
The examples inside `koolreport-examples` will make reference to `koolreport` library.
26+
27+
## Simplest way to get example running
28+
29+
The simplest way to get example running is to download the [KoolReport & Examples](https://www.koolreport.com/getting-started/#download) package from our site. The package contains both KoolReport and the examples so you only to unzip and copy to web folder to run.
30+
31+
# Notes
32+
33+
Since the example is for both KoolReport core and extended packages. The examples for extended packages may not work because extended package has not been installed. If example requires a package to run, you may look for the package in our [Extended Packages](https://www.koolreport.com/packages).
34+
35+
# Support
36+
37+
If you need any assistance, you may post questions on our [forums](https://www.koolreport.com/forum/topics) or email us at [support@koolreport.com](mailto:support@koolreport.com). We are glad to answer all of your questions.
738

839
# Author
9-
1. [KoolPHP Inc](https://www.koolphp.net) - A vendor of PHP components
40+
1. [KoolPHP Inc](https://www.koolphp.net) - A vendor of PHP components

0 commit comments

Comments
 (0)