Skip to content
This repository has been archived by the owner on May 2, 2022. It is now read-only.

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ranajitbanerjee committed Jul 31, 2020
1 parent e41fa47 commit 1d79a7b
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
[![NPM version](https://img.shields.io/npm/v/@chartshq/muze.svg)](https://www.npmjs.com/package/@chartshq/muze)
[![Contributors](https://img.shields.io/github/contributors/chartshq/muze.svg)](https://github.com/chartshq/muze/graphs/contributors)

## What is Muze?

Muze is a free **data visualization library for creating exploratory data visualizations (like Tableau)** in browser, using WebAssembly. It uses a layered Grammar of Graphics (GoG) to create composable and interactive data visualization for web. It is ideal for use in visual analytics dashboards & applications to create highly performant, interactive, multi-dimensional, and composable visualizations.

It uses a data-first approach to define the constructs and layers of the chart, automatically generates cross-chart interactivity, and allows you to over-ride any behavior or interaction on the chart.
Expand All @@ -40,7 +42,7 @@ Muze uses an in-browser **[DataModel](https://github.com/chartshq/datamodel)** t

### CDN

Insert the muze build and the required CSS into the `<head>`:
Insert the muze build and the required CSS into the `<head>`:

```html
<link href="https://cdn.jsdelivr.net/npm/@chartshq/muze@2.0.0/dist/muze.css" rel="stylesheet">
Expand Down Expand Up @@ -155,18 +157,18 @@ const muze = window.muze;
async function myAsyncFn() {
// Load the DataModel module.
const DataModel = await muze.DataModel.onReady();

// Converts the raw data into a format
// which DataModel can consume.
const formattedData = await DataModel.loadData(data, schema);

// Create a new DataModel instance with
// the formatted data.
let dm = new DataModel(formattedData);

// Create a global environment to share common configs across charts.
const env = await muze();

// Create a new canvas instance from the global
// environment to render chart on.
const canvas = env.canvas();
Expand Down Expand Up @@ -265,4 +267,4 @@ Please contribute to our public wishlist or upvote an existing feature at [Muze

## License

[Custom License](http://muzejs.org/muze-wa/eula) (Free to use)
[Custom License](http://muzejs.org/muze-wa/eula) (Free to use)

0 comments on commit 1d79a7b

Please sign in to comment.