Skip to content

DOCS: improves usage instructions format #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antoniolago merged 3 commits into from
Feb 2, 2026
Merged

DOCS: improves usage instructions format #93

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c6c84b
docs: improves usage instructions format
DevDario Feb 2, 2026
c30b2d6
Merge pull request #1 from DevDario/docs-usage-instructions-format
DevDario Feb 2, 2026
9fa6a46
Update README.md
antoniolago Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,24 @@ React Gauge Chart Component for data visualization.

A gallery of preset gauges and a sandbox editor is provided so you can create and edit your gauges in the [DEMO](https://antoniolago.github.io/react-gauge-component) page

# Usage
Install it by running `npm install react-gauge-component --save` or `yarn add react-gauge-component`. Then to use it:
## Quick Start

Install with your package manager

```js
npm install react-gauge-component --save
```
```js
pnpm add react-gauge-component --save
```
```
yarn add react-gauge-component.
```
```
bun add react-gauge-component.
```

Then import it:

```jsx
import GaugeComponent from 'react-gauge-component';
Expand Down