Skip to content

Commit 596d0ed

Browse files
committed
Update readme
1 parent 01ce6ca commit 596d0ed

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

README.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,38 @@
11
# clj-xchart
22

3-
Clojure wrapper around XChart.
3+
Clojure wrapper around XChart, a small library for rendering charts/plots.
4+
5+
![Rosling chart](rosling.png)
6+
7+
This is the latest released version
8+
([API docs](https://hypirion.github.io/clj-xchart/api/0.2.0/en/)):
9+
10+
```clj
11+
[com.hypirion/clj-xchart "0.2.0"]
12+
```
13+
14+
## What
15+
16+
clj-xchart wraps all the different chart you can generate in XChart:
17+
18+
* Line charts
19+
* Scatter charts
20+
* Area charts
21+
* Bar charts
22+
* Histogram charts
23+
* Pie charts
24+
* Donut charts
25+
* Bubble charts
26+
* Stick charts
427

528
## Usage
629

7-
It is probably wise to wait until the documentation for this thing has been
8-
written. The library itself should be fully working, but it's a bit rough around
9-
the edges without the documentation.
30+
There are a lot of examples on the
31+
[examples page](https://hypirion.github.io/clj-xchart/examples), and
32+
[the tutorial](docs/tutorial.md) should basic usage. For more advanced
33+
customisation, have a look at the [render options](docs/render-options.md) page.
34+
35+
The API is available at <https://hypirion.github.io/clj-xchart/api/0.2.0/en/>.
1036

1137
## License
1238

rosling.png

63.1 KB
Loading

0 commit comments

Comments
 (0)