Skip to content

Commit

Permalink
Add README.md documentation for the library
Browse files Browse the repository at this point in the history
  • Loading branch information
bcostaaa01 committed Feb 2, 2023
1 parent ac4348f commit 442c963
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 1 deletion.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# RadarScopeJS 🔭

RadarScopeJS is an open-source JavaScript library for creating dynamic and customizable radar charts. With support for multiple datasets and adjustable scales, RadarScopeJS makes it easy to bring your data to life with stunning visuals.

## Features 🚀

- Support for multiple datasets
- Customizable scales
- Dynamic and responsive charts
- Built with Chart.js

## Getting Started 🚀

### Installation

To install RadarScopeJS, simply run the following command:

```
npm install radar-scope-js
```

### Usage

To use RadarScopeJS in your project, simply import the library into your JavaScript file(s) where you want to use it:

```javascript
import RadarScopeJS from "radar-scope-js";
```

Then, you can use the library to create a radar chart, like this:

```javascript
const data = {
labels: ["Eating", "Drinking", "Sleeping", "Designing", "Coding", "Cycling"],
datasets: [
{
label: "My First dataset",
backgroundColor: "rgba(179,181,198,0.2)",
borderColor: "rgba(179,181,198,1)",
pointBackgroundColor: "rgba(179,181,198,1)",
pointBorderColor: "#fff",
pointHoverBackgroundColor: "#fff",
pointHoverBorderColor: "rgba(179,181,198,1)",
data: [65, 59, 90, 81, 56, 55],
},
{
label: "My Second dataset",
backgroundColor: "rgba(255,99,132,0.2)",
borderColor: "rgba(255,99,132,1)",
pointBackgroundColor: "rgba(255,99,132,1)",
pointBorderColor: "#fff",
pointHoverBackgroundColor: "#fff",
pointHoverBorderColor: "rgba(255,99,132,1)",
data: [28, 48, 40, 19, 96, 27],
},
],
};

const options = {};

const radarChart = new RadarScopeJS(data, options);
```


For more information on how to use RadarScopeJS, please see the documentation and examples included with the library.

## Support and Contributions 💪

I welcome contributions and support from the community! If you're interested in contributing to RadarScopeJS, please do so!😀

If you need help with the library, you can open an issue on the [GitHub repository](https://github.com/bcostaaa01/radar-scope-js).

## License 📜

RadarScopeJS is open-source software licensed under the [ISC License](LICENSE).

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "radar-scope-js",
"version": "1.3.0",
"version": "1.4.0",
"description": "Create stunning and dynamic radar charts with ease using RadarScope, the versatile open-source JavaScript library built with Chart.js. With customizable scales and multiple datasets support, bring your data to life with dynamic visuals.",
"main": "index.js",
"repository": "https://github.com/bcostaaa01/radar-scope-js.git",
Expand Down

0 comments on commit 442c963

Please sign in to comment.