Skip to content

Commit

Permalink
Updated readme and composer to include keywords and MIT license
Browse files Browse the repository at this point in the history
  • Loading branch information
jbogartPint committed Jun 8, 2016
1 parent 341a481 commit 153e582
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,19 @@ The purpose of this wrapper is to enable PHP users to quickly and easily create

## Initial Setup

### Manual

1. Download this repo by clicking on the green "Clone or download" button near the top of this page.
2. Click on "Download Zip" option to begin the download.
3. Copy file "zc.php" into your project's source directory.
4. Include the ZingChart library in your project `<script src="//cdn.zingchart.com/zingchart.min.js"></script>`
5. Include this wrapper in your project using the 'include' syntax. ie) `include zc.php`
4. Include the ZingChart library in your project `<script src="//cdn.zingchart.com/zingchart.min.js"></script>`.
5. Include this wrapper in your project using the 'include' syntax. ie) `include zc.php`.

### Composer
1. Download this package with Composer: `composer require zingchart/php_wrapper`.
2. AutoLoad your package dependencies in your project: `require __DIR__ . '/vendow/autoload.php;`.
3. Reference this library in your code: `use ZingChart\PHPWrapper\ZC;`.


## Quick Start

Expand Down
6 changes: 5 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
{
"name": "zingchart/php_wrapper",
"description": "PHP wrapper for ZingChart",
"homepage": "https://www.zingchart.com",
"type": "library",
"keywords": [ "ZingChart", "charts", "graphs" ],
"authors": [
{
"name": "ZingChart",
"email": "[email protected]"
}
],
"license": "MIT",
"repositories": [
{
"type": "vcs",
Expand All @@ -15,7 +19,7 @@
],
"minimum-stability": "stable",
"require": {
"php": "^5.3.3"
"php": "^5.3"
},
"autoload": {
"psr-4": {
Expand Down

0 comments on commit 153e582

Please sign in to comment.