Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maantje committed Sep 4, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent d5e06fe commit a987eff
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
> [!WARNING]
> In active development, unstable api, use at own risk.
> This library is under active development. The API is unstable and subject to change. Use at your own risk.
# Charts
# Charts - SVG Chart Rendering

Create SVG charts with PHP
**Charts** is a zero-dependency PHP library for generating SVG charts. It enables easy creation of beautiful and responsive SVG-based charts directly from PHP, with no additional dependencies required.

## Features

- Simple, intuitive API for chart creation
- Lightweight, with no external dependencies
- Supports various chart types: line charts, bar charts, stacked charts, and mixed charts
- Fully customizable and extendable
- Outputs pure SVG, allowing for:
- Embedding in PDFs (ideal for reports)

## Installation

@@ -13,7 +22,9 @@ To get started, install the package via composer:
composer require maantje/charts
```

## Usage
## Usage Examples

Below are some examples of the types of charts you can create using this library. Click on the links to view the source code for each example.

### Simple line chart
![alt text](./examples/output/simple-line-chart.svg)

0 comments on commit a987eff

Please sign in to comment.