justgage/README.md

JustGage is a handy JavaScript plugin for generating and animating nice & clean gauges. Modern ES6+ implementation with native SVG rendering (v2.0 modernized by robertsLando).

# JustGage

<p align="center"><img src="docs/public/logo.png"/></p>

[![NPM Version](https://img.shields.io/npm/v/justgage.svg)](https://www.npmjs.com/package/justgage)
[![Downloads](https://img.shields.io/npm/dm/justgage.svg)](https://www.npmjs.com/package/justgage)
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/justgage.svg)](https://bundlephobia.com/package/justgage)

[![Deploy Docs](https://github.com/toorshia/justgage/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/toorshia/justgage/actions/workflows/deploy-docs.yml)
[![CI](https://github.com/toorshia/justgage/actions/workflows/ci.yml/badge.svg)](https://github.com/toorshia/justgage/actions/workflows/ci.yml)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![MIT Licence](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

> **The gauge library you know and love, completely reimagined for the modern web! 🎉**

<p align="center">
  <b>⚡ Zero Dependencies</b> &bull;
  <b>💖 Modern ES6+</b> &bull;
  <b>🎛️ Highly Customizable</b> &bull;
  <b>📱 Responsive Design</b> &bull;
  <b>🚀 High Performance</b> &bull;
  <b>🛡️ Battle Tested</b> &bull;
  <b>📦 76% smaller </b> From 36.5 kB → 8.6 kB (27.9 kB saved!))
  </p>

  <p align="center">
    <a href="https://toorshia.github.io/justgage" style="font-weight: bold; text-decoration: none;">
      🎮 Try Live Demo &amp; Playground
    </a>
    &bull;
    <a href="https://toorshia.github.io/justgage/docs" style="font-weight: bold; text-decoration: none;">
      📚 Full Documentation
    </a>
</p>

## Quick Start

### Installation

```bash
npm install justgage
```

### Basic Usage

```javascript
import { JustGage } from 'justgage';

const gauge = new JustGage({
  id: 'my-gauge',
  value: 75,
  min: 0,
  max: 100,
});
```

## More Information

- 📖 **[Complete Documentation](https://toorshia.github.io/justgage/docs)** - API reference, configuration options, and examples
- 🎮 **[Interactive Playground](https://toorshia.github.io/justgage/playground)** - Try different configurations live
- 🚀 **[Migration Guide](https://toorshia.github.io/justgage/docs#migration)** - Upgrading from v1.x to v2.0+
- 🤝 **[Contributing](CONTRIBUTING.md)** - Development setup and contribution guidelines

## License

This project is licensed under [MIT](LICENSE) License

## Author & Maintainers

- **Original Author**: [Bojan Djuricic](https://github.com/toorshia)
- **v2.0 Modernization & Maintenance**: [robertsLando](https://github.com/robertsLando)