Skip to content

Commit

Permalink
update screenshot and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jkanche committed Oct 25, 2023
1 parent 5b3f58f commit 5239574
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

A JavaScript library to make ridge plots.

![](assets/demo.png)

Install the package from [npm](https://www.npmjs.com/package/ridges.js),

```bash
npm install ridges.js
```

The library offers both horizontal and vertical layouts for creating ridge plots. To get started, choose your preferred layout and then instantiate a new visualization object. Customize the visualization state by configuring properties such as titles, selected metrics, the number of ticks, and more. Next, input your data, and render the plot in your desired dimensions!
The library offers both **horizontal** and **vertical** layouts for creating ridge plots.

To get started, choose your preferred layout and then instantiate a new visualization object. Customize the visualization state by configuring properties such as titles, selected metrics, the number of ticks, and more. Next, input your data, and render the plot in your desired dimensions!

```js
import { VerticalRidgePlot, HorizontalRidgePlot } from "ridges.js";
Expand Down
Binary file modified assets/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5239574

Please sign in to comment.